openapi: 3.0.3 info: title: Quickstart API Reference version: '2023-11-29' description: >+ Zuora Quickstart API is recommended for new customers and integrators, allowing new integrators to swiftly integrate with Zuora. It supports essential business use cases. To use the Quickstart API, you must have the following features enabled on your tenant: * [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders) or [Orders Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization) * [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) To find the latest changes made to the Zuora Quickstart API, check the [Quickstart API Changelog](https://developer.zuora.com/quickstart-api/changelog/2022q4-changelog/). We recommend that you subscribe to [Developers Community](https://community.zuora.com/communities/community-home?communitykey=e2a932b4-50c4-4019-a3e8-362e38714df3) to get notifications when a new version is released. components: securitySchemes: bearerAuth: type: http scheme: bearer parameters: zuora-track-id: in: header name: zuora-track-id required: false description: >- A custom identifier for tracking API requests. If you set a value for this header, Zuora returns the same value in the response header. This header enables you to track your API calls to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), or quote ('). schema: type: string zuora-entity-id: in: header name: zuora-entity-ids required: false description: >- An entity ID. If you have Multi-entity enabled and the authorization token is valid for more than one entity, you must use this header to specify which entity to perform the operation on. If the authorization token is only valid for a single entity or you do not have Multi-entity enabled, you do not need to set this header. schema: type: string idempotency-key: in: header name: idempotency-key required: false description: >- Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. This idempotency key should be a unique value, and the Zuora server identifies subsequent retries of the same request using this value. For more information, see [Idempotent Requests](https://developer.zuora.com/api-references/quickstart-api/tag/Idempotent-Requests/). schema: type: string accept-encoding: in: header name: accept-encoding required: false description: >- Include a `accept-encoding: gzip` header to compress responses, which can reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes. For more information about this header, see [Request and Response Compression](https://developer.zuora.com/api-references/quickstart-api/tag/Request-and-Response-Compression/). schema: type: string content-encoding: in: header name: content-encoding required: false description: >- Include a `content-encoding: gzip` header to compress a request. Upload a gzipped file for the payload if you specify this header. For more information, see [Request and Response Compression](https://developer.zuora.com/api-references/quickstart-api/tag/Request-and-Response-Compression/). schema: type: string async: in: header name: async required: false description: >- Making asynchronous requests allows you to scale your applications more efficiently by leveraging Zuora's infrastructure to enqueue and execute requests for you without blocking. These requests also use built-in retry semantics, which makes them much less likely to fail for non-deterministic reasons, even in extreme high-throughput scenarios. Meanwhile, when you send a request to one of these endpoints, you can expect to receive a response in less than 150 milliseconds and these calls are unlikely to trigger rate limit errors. If set to true, Zuora returns a 202 Accepted response, and the response body contains only a request ID. schema: type: boolean default: false responses: bad_request: description: Bad Request content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Bad Request example: type: bad_request errors: - code: invalid_parameter parameter: currency message: '''currency'' length must be between 3 and 3' retryable: false headers: ratelimit-limit: description: >- The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information. schema: type: string ratelimit-remaining: description: >- The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information. schema: type: number ratelimit-reset: description: >- The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information. schema: type: number zuora-request-id: description: Zuora’s internal identifier for this request. schema: type: string zuora-track-id: description: >- A user-supplied identifier for this request. If you supply a `zuora-track-id` as a request header, Zuora returns the `zuora-track-id` as a response header. schema: type: string unauthorized: description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Unauthorized example: type: unauthorized errors: [] retryable: false headers: ratelimit-limit: description: >- The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information. schema: type: string ratelimit-remaining: description: >- The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information. schema: type: number ratelimit-reset: description: >- The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information. schema: type: number zuora-request-id: description: Zuora’s internal identifier for this request. schema: type: string zuora-track-id: description: >- A user-supplied identifier for this request. If you supply a `zuora-track-id` as a request header, Zuora returns the `zuora-track-id` as a response header. schema: type: string not_found: description: Not Found content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Not Found example: type: not_found errors: - code: resource_not_found parameter: id message: Resource 2c92c0f974e9737a0175034cc0cc10c could not be found retryable: false headers: ratelimit-limit: description: >- The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information. schema: type: string ratelimit-remaining: description: >- The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information. schema: type: number ratelimit-reset: description: >- The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information. schema: type: number zuora-request-id: description: Zuora’s internal identifier for this request. schema: type: string zuora-track-id: description: >- A user-supplied identifier for this request. If you supply a `zuora-track-id` as a request header, Zuora returns the `zuora-track-id` as a response header. schema: type: string method_not_allowed: description: Method Not Allowed content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Method Not Allowed example: type: method_not_allowed retryable: false errors: [] headers: ratelimit-limit: description: >- The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information. schema: type: string ratelimit-remaining: description: >- The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information. schema: type: number ratelimit-reset: description: >- The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information. schema: type: number zuora-request-id: description: Zuora’s internal identifier for this request. schema: type: string zuora-track-id: description: >- A user-supplied identifier for this request. If you supply a `zuora-track-id` as a request header, Zuora returns the `zuora-track-id` as a response header. schema: type: string too_many_requests: description: Too Many Requests content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Too Many Requests example: type: too_many_requests errors: [] headers: ratelimit-limit: description: >- The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information. schema: type: string ratelimit-remaining: description: >- The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information. schema: type: number ratelimit-reset: description: >- The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information. schema: type: number zuora-request-id: description: Zuora’s internal identifier for this request. schema: type: string zuora-track-id: description: >- A user-supplied identifier for this request. If you supply a `zuora-track-id` as a request header, Zuora returns the `zuora-track-id` as a response header. schema: type: string internal_server_error: description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Internal Server Error example: type: internal_server_error errors: [] headers: ratelimit-limit: description: >- The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information. schema: type: string ratelimit-remaining: description: >- The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information. schema: type: number ratelimit-reset: description: >- The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information. schema: type: number zuora-request-id: description: Zuora’s internal identifier for this request. schema: type: string zuora-track-id: description: >- A user-supplied identifier for this request. If you supply a `zuora-track-id` as a request header, Zuora returns the `zuora-track-id` as a response header. schema: type: string bad_gateway: description: Bad Gateway content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Bad Gateway example: type: bad_gateway errors: [] headers: ratelimit-limit: description: >- The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information. schema: type: string ratelimit-remaining: description: >- The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information. schema: type: number ratelimit-reset: description: >- The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information. schema: type: number zuora-request-id: description: Zuora’s internal identifier for this request. schema: type: string zuora-track-id: description: >- A user-supplied identifier for this request. If you supply a `zuora-track-id` as a request header, Zuora returns the `zuora-track-id` as a response header. schema: type: string service_unavailable: description: Service Unavailable content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Service Unavailable example: type: service_unavailable errors: [] headers: ratelimit-limit: description: >- The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information. schema: type: string ratelimit-remaining: description: >- The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information. schema: type: number ratelimit-reset: description: >- The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information. schema: type: number zuora-request-id: description: Zuora’s internal identifier for this request. schema: type: string zuora-track-id: description: >- A user-supplied identifier for this request. If you supply a `zuora-track-id` as a request header, Zuora returns the `zuora-track-id` as a response header. schema: type: string gateway_timeout: description: Gateway Timeout content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Gateway Timeout example: type: gateway_timeout errors: [] headers: ratelimit-limit: description: >- The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information. schema: type: string ratelimit-remaining: description: >- The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information. schema: type: number ratelimit-reset: description: >- The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information. schema: type: number zuora-request-id: description: Zuora’s internal identifier for this request. schema: type: string zuora-track-id: description: >- A user-supplied identifier for this request. If you supply a `zuora-track-id` as a request header, Zuora returns the `zuora-track-id` as a response header. schema: type: string schemas: GetByIdQueryParams: type: object additionalProperties: true title: GetByIdQueryParams properties: expand[]: type: array x-java-sdk-legacy-param: true items: type: string description: >- Allows you to expand responses by including related object information in a single call. See the [Expand responses](https://developer.zuora.com/quickstart-api/tutorial/expand-responses/) section of the Quickstart API Tutorials for detailed instructions. filter[]: type: array x-java-sdk-legacy-param: false items: type: string description: >- A case-sensitive filter on the list. See the [Filter lists](https://developer.zuora.com/quickstart-api/tutorial/filter-lists/) section of the Quickstart API Tutorial for detailed instructions. Note that the filters on this operation are only applicable to the related objects. For example, when you are calling the "Retrieve a billing document" operation, you can use the `filter[]` parameter on the related objects such as `filter[]=items[account_id].EQ:8ad09e208858b5cf0188595208151c63` page_size: type: integer x-java-sdk-legacy-param: false minimum: 1 maximum: 99 description: >- The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 99, Zuora will return a 400 error. listQueryParams: type: object additionalProperties: true title: ListQueryParams properties: cursor: type: string x-java-sdk-legacy-param: true 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. expand[]: type: array x-java-sdk-legacy-param: true items: type: string description: >- Allows you to expand responses by including related object information in a single call. See the [Expand responses](https://developer.zuora.com/quickstart-api/tutorial/expand-responses/) section of the Quickstart API Tutorials for detailed instructions. filter[]: type: array x-java-sdk-legacy-param: true items: type: string description: >- A case-sensitive filter on the list. See the [Filter lists](https://developer.zuora.com/quickstart-api/tutorial/filter-lists/) section of the Quickstart API Tutorials for detailed instructions. sort[]: type: array x-java-sdk-legacy-param: false items: type: string description: >- A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `account_number.asc`) or descending (e.g. `account_number.desc`). You cannot sort on properties that are arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. page_size: type: integer x-java-sdk-legacy-param: false minimum: 1 maximum: 99 description: >- The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 99, Zuora will return a 400 error. customFields: type: object title: CustomFields description: >- Set of user-defined fields associated with this object. Useful for storing additional information about the object in a structured format. x-extra-field-annotation: '@JsonAdapter(CustomFieldAdapter.class)' additionalProperties: true custom_object: type: object title: Custom_object description: The custom object data. additionalProperties: true properties: id: type: string readOnly: true description: Unique identifier for the object. updated_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who last updated the object updated_time: type: string format: date-time readOnly: true description: >- The date and time when the object was last updated in ISO 8601 UTC format. created_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who created the object created_time: type: string format: date-time readOnly: true description: >- The date and time when the object was created in ISO 8601 UTC format. custom_fields: type: object title: CustomFields description: >- Set of user-defined fields associated with this object. Useful for storing additional information about the object in a structured format. x-extra-field-annotation: '@JsonAdapter(CustomFieldAdapter.class)' additionalProperties: true custom_objects: oneOf: - $ref: '#/components/schemas/listCustomObjectResponse' - $ref: '#/components/schemas/custom_object' readOnly: true description: The custom objects associated with a Zuora standard object. type: type: string readOnly: true description: Custom Object Definition Type. customObjectCreateRequest: type: object title: CustomObjectCreateRequest description: '' additionalProperties: true example: fieldName__c: sample Value customObjectPatchRequest: type: object title: CustomObjectPatchRequest description: '' additionalProperties: true listCustomObjectResponse: type: object title: ListCustomObjectResponse description: A list of custom objects. additionalProperties: false properties: next_page: type: string nullable: true data: type: array items: $ref: '#/components/schemas/custom_object' address: type: object title: Address description: Container for the address informtion. additionalProperties: false properties: line1: type: string description: Address line 1 (e.g., street, PO Box, or company name). example: 3333 Piedmont Rd NE line2: type: string description: Address line 2 (e.g., apartment, suite, unit, or building). example: Suite 1150 city: type: string description: City, district, suburb, town, or village. example: Atlanta state: type: string description: State or providence example: GA country: type: string description: The country of the contact's address. example: United States county: type: string description: Zuora Tax uses this information to calculate county taxation. postal_code: type: string description: ZIP or postal code. example: '30305' financeInformation: type: object title: FinanceInformation description: '' nullable: false additionalProperties: false properties: accounting_code: type: string description: >- An active accounting code defined in **Finance Settings > Configure Accounting Codes** in your Zuora tenant. account_receivable_accounting_code: type: string description: An active account in your Zuora Chart of Accounts. money: type: object additionalProperties: type: number example: USD: 10 GBP: 15 queryRunFile: type: object title: QueryRunFile description: The file object representing the results of the query. additionalProperties: false properties: id: type: string readOnly: true description: Unique identifier for the object. url: type: string description: The URL from which the file can be downloaded content_type: type: string enum: - json - jsonl - csv - tsv - dsv description: The type of the file returned. type: type: string enum: - query_run description: The type of file. queryRun: type: object title: QueryRun description: Query run information. additionalProperties: false properties: created_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who created the object. id: type: string readOnly: true description: Unique identifier for the object. sql: type: string description: The SQL statement of the query. remaining_attempts: type: number description: >- The remaining number of times Zuora will attempt the query before terminating the query and setting the state to `failed`. updated_time: type: string format: date-time readOnly: true description: >- The date and time when the object was last updated in ISO-8601 UTC format. file: type: object title: QueryRunFile description: The file object representing the results of the query. additionalProperties: false properties: id: type: string readOnly: true description: Unique identifier for the object. url: type: string description: The URL from which the file can be downloaded content_type: type: string enum: - json - jsonl - csv - tsv - dsv description: The type of the file returned. type: type: string enum: - query_run description: The type of file. number_of_rows: type: number description: The number of rows in the output file. processing_duration: type: number description: The time taken to process the query in milliseconds. state: type: string enum: - pending - accepted - in_progress - complete - failed - canceled description: >- The query's execution state, which will be completed for successful runs. column_separator: type: string description: >- The character used as delimiter to separate values in the output file. queryRunListResponse: type: object title: QueryRunListResponse description: '' nullable: false additionalProperties: false properties: next_page: type: string nullable: true data: type: array items: $ref: '#/components/schemas/queryRun' queryRunCreateRequest: type: object title: QueryRunCreateRequest description: '' additionalProperties: false properties: column_separator: type: string description: >- The character used as delimiter to separate values in the output file. content_encoding: type: string enum: - gzip - zip - none description: >- If supplied, Zuora with compress the output file using the specified compression algorithm. encryption_key: type: string description: >- Base64-encoded public key of a 1024-bit RSA key-pair. If you set this field, Zuora will encrypt the query results using the provided public key. You must use the corresponding private key to decrypt the query results. content_type: type: string enum: - json - csv - tsv - dsv description: The type of the file returned. sql: type: string description: The SQL statement of the query. read_deleted: type: boolean description: If set to `true`, any deleted records are included in the response. required: - sql - content_type contact: type: object title: Contact description: '' nullable: false additionalProperties: false properties: id: type: string readOnly: true description: Unique identifier for the object. updated_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who last updated the object updated_time: type: string format: date-time readOnly: true description: >- The date and time when the object was last updated in ISO 8601 UTC format. created_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who created the object created_time: type: string format: date-time readOnly: true description: >- The date and time when the object was created in ISO 8601 UTC format. custom_fields: type: object title: CustomFields description: >- Set of user-defined fields associated with this object. Useful for storing additional information about the object in a structured format. x-extra-field-annotation: '@JsonAdapter(CustomFieldAdapter.class)' additionalProperties: true custom_objects: oneOf: - $ref: '#/components/schemas/listCustomObjectResponse' - $ref: '#/components/schemas/custom_object' readOnly: true description: The custom objects associated with a Zuora standard object. address: type: object title: Address description: Container for the address informtion. additionalProperties: false properties: line1: type: string description: Address line 1 (e.g., street, PO Box, or company name). example: 3333 Piedmont Rd NE line2: type: string description: Address line 2 (e.g., apartment, suite, unit, or building). example: Suite 1150 city: type: string description: City, district, suburb, town, or village. example: Atlanta state: type: string description: State or providence example: GA country: type: string description: The country of the contact's address. example: United States county: type: string description: Zuora Tax uses this information to calculate county taxation. postal_code: type: string description: ZIP or postal code. example: '30305' first_name: type: string description: Customer first name. example: Amy home_phone: type: string description: Customer home phone (including extension). example: (888)976-9056 last_name: type: string description: Customer last name. example: Lawrence mobile_phone: type: string description: Customer phone (including extension). example: (888)101-0011 nickname: type: string description: Nickname for this contact. example: Ami other_phone: type: string description: Other customer phone (including extension). example: (888)100-0001 email: type: string description: Customer email address. example: alawrence@gmail.com tax_region: type: string description: A region defined in your Zuora Tax rules. example: Georgia work_email: type: string description: Customer work email. example: alawrence@zuora.com work_phone: type: string description: Customer work phone. example: (888)976-9056 other_phone_type: type: string enum: - work - mobile - home - other description: The type of the additional phone number. fax: type: string description: The contact's fax number. account_id: type: string description: >- Identifier of a customer account with which this contact is associated. example: 2c92c0f86a8dd422016a9e7a70116b0d contactPatchRequest: type: object title: ContactPatchRequest description: '' nullable: false additionalProperties: false properties: id: type: string readOnly: true description: Unique identifier for the object. updated_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who last updated the object updated_time: type: string format: date-time readOnly: true description: >- The date and time when the object was last updated in ISO 8601 UTC format. created_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who created the object created_time: type: string format: date-time readOnly: true description: >- The date and time when the object was created in ISO 8601 UTC format. custom_fields: $ref: '#/components/schemas/customFields' custom_objects: oneOf: - $ref: '#/components/schemas/listCustomObjectResponse' - $ref: '#/components/schemas/custom_object' readOnly: true description: The custom objects associated with a Zuora standard object. address: $ref: '#/components/schemas/address' first_name: type: string description: Customer first name. example: Amy home_phone: type: string description: Customer home phone (including extension). example: (888)976-9056 last_name: type: string description: Customer last name. example: Lawrence mobile_phone: type: string description: Customer phone (including extension). example: (888)101-0011 nickname: type: string description: Nickname for this contact. example: Ami other_phone: type: string description: Other customer phone (including extension). example: (888)100-0001 email: type: string description: Customer email address. example: alawrence@gmail.com tax_region: type: string description: A region defined in your Zuora Tax rules. example: Georgia work_email: type: string description: Customer work email. example: alawrence@zuora.com work_phone: type: string description: Customer work phone. example: (888)976-9056 other_phone_type: type: string enum: - work - mobile - home - other description: The type of the additional phone number. fax: type: string description: The contact's fax number. account_id: type: string description: >- Identifier of a customer account with which this contact is associated. example: 2c92c0f86a8dd422016a9e7a70116b0d contactCreateRequest: type: object title: ContactCreateRequest description: '' additionalProperties: false properties: id: type: string readOnly: true description: Unique identifier for the object. updated_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who last updated the object updated_time: type: string format: date-time readOnly: true description: >- The date and time when the object was last updated in ISO 8601 UTC format. created_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who created the object created_time: type: string format: date-time readOnly: true description: >- The date and time when the object was created in ISO 8601 UTC format. custom_fields: $ref: '#/components/schemas/customFields' custom_objects: oneOf: - $ref: '#/components/schemas/listCustomObjectResponse' - $ref: '#/components/schemas/custom_object' readOnly: true description: The custom objects associated with a Zuora standard object. address: $ref: '#/components/schemas/address' first_name: type: string description: Customer first name. example: Amy home_phone: type: string description: Customer home phone (including extension). example: (888)976-9056 last_name: type: string description: Customer last name. example: Lawrence mobile_phone: type: string description: Customer phone (including extension). example: (888)101-0011 nickname: type: string description: Nickname for this contact. example: Ami other_phone: type: string description: Other customer phone (including extension). example: (888)100-0001 email: type: string description: Customer email address. example: alawrence@gmail.com tax_region: type: string description: A region defined in your Zuora Tax rules. example: Georgia work_email: type: string description: Customer work email. example: alawrence@zuora.com work_phone: type: string description: Customer work phone. example: (888)976-9056 other_phone_type: type: string enum: - work - mobile - home - other description: The type of the additional phone number. fax: type: string description: The contact's fax number. account_id: type: string description: >- Identifier of a customer account with which this contact is associated. Either `account_id` or `account_number` is required. example: 2c92c0f86a8dd422016a9e7a70116b0d account_number: type: string description: >- Human-readable identifier of the account with which this contact is associated. Either `account_number` or `account_id` is required. example: RC-00020831 required: - first_name - last_name accountContactCreateRequest: type: object title: AccountContactCreateRequest description: '' additionalProperties: false properties: id: type: string readOnly: true description: Unique identifier for the object. updated_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who last updated the object updated_time: type: string format: date-time readOnly: true description: >- The date and time when the object was last updated in ISO 8601 UTC format. created_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who created the object created_time: type: string format: date-time readOnly: true description: >- The date and time when the object was created in ISO 8601 UTC format. custom_fields: $ref: '#/components/schemas/customFields' custom_objects: oneOf: - $ref: '#/components/schemas/listCustomObjectResponse' - $ref: '#/components/schemas/custom_object' readOnly: true description: The custom objects associated with a Zuora standard object. address: $ref: '#/components/schemas/address' first_name: type: string description: Customer first name. example: Amy home_phone: type: string description: Customer home phone (including extension). example: (888)976-9056 last_name: type: string description: Customer last name. example: Lawrence mobile_phone: type: string description: Customer phone (including extension). example: (888)101-0011 nickname: type: string description: Nickname for this contact. example: Ami other_phone: type: string description: Other customer phone (including extension). example: (888)100-0001 email: type: string description: Customer email address. example: alawrence@gmail.com tax_region: type: string description: A region defined in your Zuora Tax rules. example: Georgia work_email: type: string description: Customer work email. example: alawrence@zuora.com work_phone: type: string description: Customer work phone. example: (888)976-9056 other_phone_type: type: string enum: - work - mobile - home - other description: The type of the additional phone number. fax: type: string description: The contact's fax number. required: - first_name - last_name accountContactPatchRequest: type: object title: AccountContactPatchRequest description: '' nullable: false additionalProperties: false properties: id: type: string readOnly: true description: Unique identifier for the object. updated_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who last updated the object updated_time: type: string format: date-time readOnly: true description: >- The date and time when the object was last updated in ISO 8601 UTC format. created_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who created the object created_time: type: string format: date-time readOnly: true description: >- The date and time when the object was created in ISO 8601 UTC format. custom_fields: $ref: '#/components/schemas/customFields' custom_objects: oneOf: - $ref: '#/components/schemas/listCustomObjectResponse' - $ref: '#/components/schemas/custom_object' readOnly: true description: The custom objects associated with a Zuora standard object. address: $ref: '#/components/schemas/address' first_name: type: string description: Customer first name. example: Amy home_phone: type: string description: Customer home phone (including extension). example: (888)976-9056 last_name: type: string description: Customer last name. example: Lawrence mobile_phone: type: string description: Customer phone (including extension). example: (888)101-0011 nickname: type: string description: Nickname for this contact. example: Ami other_phone: type: string description: Other customer phone (including extension). example: (888)100-0001 email: type: string description: Customer email address. example: alawrence@gmail.com tax_region: type: string description: A region defined in your Zuora Tax rules. example: Georgia work_email: type: string description: Customer work email. example: alawrence@zuora.com work_phone: type: string description: Customer work phone. example: (888)976-9056 other_phone_type: type: string enum: - work - mobile - home - other description: The type of the additional phone number. fax: type: string description: The contact's fax number. accountPreviewRequest: type: object title: AccountPreviewRequest description: '' additionalProperties: false properties: exclude: type: string enum: - one_time - recurring - usage description: Any combination of one-time, recurring, and usage. include_draft_items: type: boolean description: Indicates whether to include items in the draft status. include_evergreen_subscriptions: type: boolean description: Indicates whether to include evergreen subscriptions. target_date: type: string format: date description: >- The target date is used to determine which charges to bill. All unbilled charges as of or prior to the target date are included. Zuora automatically keeps track of all charges that need to be billed and that have not been billed prior to the target date. example: '2022-01-01' required: - target_date creditMemoItemPreviewResponse: type: object title: CreditMemoItemPreviewResponse description: '' nullable: false additionalProperties: false properties: amount: type: number description: The total amount of this credit memo item. subtotal: type: number description: The total amount of this credit memo item exclusive of tax. applied_to_item_id: type: string description: >- Identifier of an invoice item that this credit memo item is applied to. document_item_date: type: string format: date-time description: The date when the credit memo item takes effect. example: '2022-01-01T07:08:12-07:00' document_item_number: type: string charge_type: type: string description: >- Type of the charge. It can be one of the following types: one-time, recurring, or usage. description: type: string description: >- An arbitrary string associated with the object. Often useful for displaying to users. id: type: string description: Unique identifier of the object processing_type: type: string enum: - subscription_item - discount - prepayment - tax quantity: type: number description: The number of units of this item. subscription_item_id: type: string description: >- The identifier the subscription item associated with this credit memo item. service_start_date: type: string description: >- The start date of the service period associated with this credit memo item. If the associated charge is a one-time fee, then this date is the date of that charge. service_end_date: type: string description: >- The end date of the service period associated with this credit memo item. If the associated charge is a one-time fee, then this date is the date of that charge. sku: type: string description: >- The unique SKU (stock keeping unit) of the product associated with this item. sku_name: type: string description: The name of the SKU associated with this item subscription_id: type: string description: >- The identifier of the subscription associated with the credit memo item. subscription_number: type: string description: >- Human-readable identifier of the subscription. It can be user-supplied. unit_of_measure: type: string description: Specifies the units used to measure usage. invoiceItemPreviewResponse: type: object title: InvoiceItemPreviewResponse description: '' nullable: false additionalProperties: false properties: amount: type: number description: The total amount of this invoice item. applied_to_item_id: type: string description: >- Identifier of an invoice item or a debit memo item that this discount item or credit memo item is applied to. document_date: type: string format: date example: '2022-01-01' subscription_item_description: type: string subscription_item_id: type: string description: >- The identifier the subscription item associated with this invoice item. subscription_item_name: type: string subscription_item_number: type: string description: >- Human-readable identifier of the subscription item. It can be user-supplied. charge_type: type: string description: >- Type of the charge. It can be one of the following types: one-time, recurring, or usage. id: type: string description: Unique identifier of the object processing_type: type: string enum: - subscription_item - discount - prepayment - tax product_name: type: string quantity: type: number description: The number of units of this item. service_start_date: type: string description: >- The start date of the service period associated with this invoice item. If the associated charge is a one-time fee, then this date is the date of that charge. service_end_date: type: string description: >- The end date of the service period associated with this invoice item. If the associated charge is a one-time fee, then this date is the date of that charge. subscription_id: type: string description: The identifier of the subscription associated with the invoice item. subscription_number: type: string description: >- The subscription number of the subscription associated with this item. subscription_name: type: string description: The name of the subscription associated with this item. tax: type: number description: The amount of tax applied to the invoice item. unit_of_measure: type: string description: Specifies the units used to measure usage. accountPreviewResponse: type: object title: AccountPreviewResponse description: '' nullable: false additionalProperties: false properties: account_id: type: string description: >- The unique identifier of the customer account associated with these items. credit_memo_items: type: array items: allOf: - $ref: '#/components/schemas/creditMemoItemPreviewResponse' invoice_items: type: array items: allOf: - $ref: '#/components/schemas/invoiceItemPreviewResponse' taxIdentifier: type: object title: TaxIdentifier description: An object that contains the VAT Identification number. additionalProperties: false properties: id: type: string description: >- Value Added Tax (VAT) ID. Each VAT ID must begin with the code of the country code and followed by a block of digits or characters. generateBillingDocumentsAccountRequest: type: object title: GenerateBillingDocumentsAccountRequest description: '' nullable: false additionalProperties: false properties: post: type: boolean description: If true, invoices will be automatically posted. example: true renew: type: boolean description: If true, subscriptions will be automatically renewed. example: true charges_excluded: type: string description: >- Charge type or types to be excluded. Can be `one_time`,`recurring`, or `usage`. credit_memo_reason_code: type: string description: >- A code identifying the reason for the credit memo transaction that is generated by the request. The value must be an existing reason code. If you do not pass the field or pass the field with empty value, Zuora uses the default reason code. document_date: type: string format: date description: The date when the credit memo is applied example: '2023-01-01' subscription_ids: type: array items: type: string description: >- The IDs of the subscriptions that you want to create the billing documents for. Each value must be the unique identifier of the latest version of an active subscription. target_date: type: string format: date description: All unbilled items on or before this date are included. example: '2023-01-01' generateBillingDocumentsAccountResponse: type: object title: GenerateBillingDocumentsAccountResponse description: '' nullable: false additionalProperties: false properties: credit_memos: allOf: - $ref: '#/components/schemas/creditMemoListResponse' description: Array of credit memos. invoices: allOf: - $ref: '#/components/schemas/invoiceListResponse' description: Array of invoices. billingDocumentSettings: type: object title: BillingDocumentSettings description: Billing document settings for an account additionalProperties: false properties: credit_memo_template_id: type: string description: >- Identifier of the credit memo template associated with this customer. example: 2c92c08b6a8c978f016a9e0084622b62 debit_memo_template_id: type: string description: Identifier of the debit memo template associated with this customer. example: 2c92c08c6a8c7e08016a9ec8d72f3ab5 email_documents: type: boolean description: Whether the customer wants to receive email invoices. example: alawrence@zuora.com print_documents: type: boolean description: Whether the customer wants to receive printed invoices. example: false invoice_template_id: type: string description: Identifier of the invoice template associated with this customer. example: 8f64d4d754739d85d0346e00ef77e50d additional_email: type: array items: type: string description: A list of additional email addresses to receive email notifications. example: jdoe@zuora.com taxCertificate: type: object title: TaxCertificate description: The tax certificate information. additionalProperties: false properties: company_code: type: string description: >- Unique code that identifies a company account in Avalara. Use this field to calculate taxes based on country of origin and sold-to addresses in Avalara. example: ABC id: type: string description: Identifier of the tax exemption certificate. start_date: type: string format: date description: The tax certificate start date. example: '2022-01-01' description: type: string description: Description of the tax exemption certificate. entity_use_code: type: string description: >- A unique entity use code used by Avalara to apply exemptions. This field is required only when you choose Avalara as your tax engine. See [Exempt Transactions](https://developer.avalara.com/avatax/handling-tax-exempt-customers/) for more information. end_date: type: string format: date description: The tax certificate end date. example: '2023-01-01' issuing_jurisdiction: type: string description: Typically, this is a state or government agency example: Georgia state: type: string enum: - pending - verified - not_valid description: >- Status of the tax exemption certificate, indication whether the certificate has been verified. tax_identifier: type: string deprecated: true description: >- Value Added Tax (VAT) ID. Each VAT ID must begin with the code of the country code and followed by a block of digits or characters. example: DE123456789 taxationItem: type: object title: TaxationItem description: taxation information for this billing document item. additionalProperties: false properties: id: type: string description: >- Identifier of the taxation item related to the invoice. Only applicable for credit memos created from invoices. updated_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who last updated the object updated_time: type: string format: date-time readOnly: true description: >- The date and time when the object was last updated in ISO 8601 UTC format. created_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who created the object created_time: type: string format: date-time readOnly: true description: >- The date and time when the object was created in ISO 8601 UTC format. custom_fields: type: object title: CustomFields description: >- Set of user-defined fields associated with this object. Useful for storing additional information about the object in a structured format. x-extra-field-annotation: '@JsonAdapter(CustomFieldAdapter.class)' additionalProperties: true custom_objects: oneOf: - $ref: '#/components/schemas/listCustomObjectResponse' - $ref: '#/components/schemas/custom_object' readOnly: true description: The custom objects associated with a Zuora standard object. jurisdiction: type: string maxLength: 32 description: >- The jurisdiction that applies the tax or VAT. This value is typically a state, province, county, or city. location_code: type: string maxLength: 32 description: >- The identifier for the location based on the value of the `tax_code` field. name: type: string maxLength: 128 description: The name of the taxation item. amount: type: number description: The amount of the tax applied to the total price. tax_code: type: string description: >- A tax code identifier. If a `tax_code` of a price is not provided when you create or update a price, Zuora will treat the charged amount as non-taxable. If this code is provide, Zuora considers that this price is taxable and the charged amount will be handled accordingly. tax_code_name: type: string description: The amount of the tax applied to the total price. tax_date: type: string format: date description: The date on which the tax is applied. example: '2022-01-01' tax_rate: type: number description: The amount of the tax applied to the total price. tax_rate_name: type: string description: >- The name of the tax rate, such as sales tax or GST. This name is displayed on billing documents. amount_exempt: type: number description: The calculated tax amount excluded due to the exemption. source_tax_item_id: type: string description: >- The ID of the taxation item of the invoice, from which the credit or debit memo is created. This field is only applicable when the `type` of the billing document is `credit_memo` and `debit_memo`. remaining_balance: type: number readOnly: true description: The remaining balance of the taxation item. amount_credited: type: number readOnly: true description: The credit memo amount applied to the taxation item. amount_paid: type: number readOnly: true description: The payment amount applied to the taxation item. amount_refunded: type: number readOnly: true description: The refund amount applied to the taxation item. amount_applied: type: number readOnly: true description: The credit memo item amount applied to the taxation item. sales_tax_payable_account: type: string description: An active account in your Zuora Chart of Accounts. on_account_account: type: string description: An active account in your Zuora Chart of Accounts. tax_inclusive: type: boolean description: If set to `true`, it indicates that amounts are inclusive of tax. tax_rate_type: type: string enum: - percent - amount description: Indicates whether the tax rate is an amount or a percentage. taxationItemListResponse: type: object title: TaxationItemListResponse description: Information of the taxation items. additionalProperties: false properties: next_page: type: string nullable: true data: type: array items: $ref: '#/components/schemas/taxationItem' taxationItemPatchRequest: type: object title: TaxationItemPatchRequest description: '' nullable: false additionalProperties: false properties: id: type: string readOnly: true description: Unique identifier for the object. updated_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who last updated the object updated_time: type: string format: date-time readOnly: true description: >- The date and time when the object was last updated in ISO 8601 UTC format. created_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who created the object created_time: type: string format: date-time readOnly: true description: >- The date and time when the object was created in ISO 8601 UTC format. custom_fields: $ref: '#/components/schemas/customFields' custom_objects: oneOf: - $ref: '#/components/schemas/listCustomObjectResponse' - $ref: '#/components/schemas/custom_object' readOnly: true description: The custom objects associated with a Zuora standard object. on_account_account: type: string description: An active account in your Zuora Chart of Accounts. amount_exempt: type: number description: The calculated tax amount excluded due to the exemption. invoice_item_id: type: string description: >- Unique identifier of the invoice item to which the taxation item applies. jurisdiction: type: string maxLength: 32 description: >- The jurisdiction that applies the tax or VAT. This value is typically a state, province, county, or city. location_code: type: string maxLength: 32 description: >- The identifier for the location based on the value of the `tax_code` field. name: type: string maxLength: 128 description: The name of the taxation item. amount: type: number description: The amount of the tax applied to the total price. tax_code: type: string description: >- A tax code identifier. If a `tax_code` of a price is not provided when you create or update a price, Zuora will treat the charged amount as non-taxable. If this code is provide, Zuora considers that this price is taxable and the charged amount will be handled accordingly. tax_code_name: type: string description: The amount of the tax applied to the total price. tax_date: type: string format: date description: The date on which the tax is applied. example: '2022-01-01' tax_rate: type: number description: The amount of the tax applied to the total price. tax_rate_name: type: string description: >- The name of the tax rate, such as sales tax or GST. This name is displayed on billing documents. tax_rate_type: type: string enum: - percent - amount description: Indicates whether the tax rate is an amount or a percentage. source_tax_item_id: type: string description: >- The ID of the taxation item of the invoice, from which the credit or debit memo is created. This field is only applicable when the `type` of the billing document is `credit_memo` and `debit_memo`. tax_inclusive: type: boolean description: If set to `true`, it indicates that amounts are inclusive of tax. sales_tax_payable_account: type: string description: An active account in your Zuora Chart of Accounts. taxationItemCreateRequest: type: object title: TaxationItemCreateRequest description: '' additionalProperties: false properties: on_account_account: type: string description: An active account in your Zuora Chart of Accounts. amount_exempt: type: number description: The calculated tax amount excluded due to the exemption. invoice_item_id: type: string description: >- Unique identifier of the invoice item to which the taxation item applies. jurisdiction: type: string maxLength: 32 description: >- The jurisdiction that applies the tax or VAT. This value is typically a state, province, county, or city. location_code: type: string maxLength: 32 description: >- The identifier for the location based on the value of the `tax_code` field. name: type: string maxLength: 128 description: The name of the taxation item. amount: type: number description: The amount of the tax applied to the total price. tax_code: type: string description: >- A tax code identifier. If a `tax_code` of a price is not provided when you create or update a price, Zuora will treat the charged amount as non-taxable. If this code is provide, Zuora considers that this price is taxable and the charged amount will be handled accordingly. tax_code_name: type: string description: The amount of the tax applied to the total price. tax_date: type: string format: date description: The date on which the tax is applied. example: '2022-01-01' tax_rate: type: number description: The amount of the tax applied to the total price. tax_rate_name: type: string description: >- The name of the tax rate, such as sales tax or GST. This name is displayed on billing documents. tax_rate_type: type: string enum: - percent - amount description: Indicates whether the tax rate is an amount or a percentage. source_tax_item_id: type: string description: >- The ID of the taxation item of the invoice, from which the credit or debit memo is created. This field is only applicable when the `type` of the billing document is `credit_memo` and `debit_memo`. tax_inclusive: type: boolean description: If set to `true`, it indicates that amounts are inclusive of tax. required: - tax_date - name - amount - tax_code - tax_rate - invoice_item_id customerAcceptanceMandate: type: object title: CustomerAcceptanceMandate description: Details about the customer’s acceptance of the mandate. additionalProperties: false properties: id: type: string readOnly: true description: A reference to the consent agreement you have with your customer. date: type: string format: date readOnly: true description: The date on which the customer accepted the mandate. mandate: type: object title: Mandate description: >- The mandate information for the Credit Card, Credit Card Reference Transaction, ACH, or Bank Transfer payment method. additionalProperties: false properties: id: type: string description: >- Identifier of the single- or multi-use mandate generated by the payment gateway. reason: type: string description: Reason for the mandate. state: type: string enum: - active - canceled - expired - agreed readOnly: true description: >- The status of the mandate, which indicates whether it can be used to initiate a payment. cardMandate: type: object title: CardMandate description: >- A mandate is a record of the permission a customer has given you to debit their payment method. This hash contains details about the mandate. additionalProperties: false properties: id: type: string description: >- Identifier of the single- or multi-use mandate generated by the payment gateway. reason: type: string description: Reason for the mandate. state: type: string enum: - active - canceled - expired - agreed readOnly: true description: >- The status of the mandate, which indicates whether it can be used to initiate a payment. network_transaction_id: type: string readOnly: true description: Identifier of a network transaction. example: '1234567890' customer_acceptance: allOf: - $ref: '#/components/schemas/customerAcceptanceMandate' readOnly: true description: A reference to the consent agreement you have with your customer. type: type: string enum: - multi_use - single_use readOnly: true description: Indicates the type of the stored credential profile, if any. verified: type: boolean readOnly: true description: >- Indicates the mandate was verified with the payment gateway by Zuora. example: true verify: type: boolean description: Specifies if Zuora should verify this mandate. example: false ccRefMandate: type: object title: CcRefMandate description: '' nullable: false additionalProperties: false properties: id: type: string description: >- Identifier of the single- or multi-use mandate generated by the payment gateway. paypalExpress: type: object title: PaypalExpress description: >- If it is a `paypal_express` payment method, this hash contains details about the PayPal Express payment method. additionalProperties: false properties: baid: type: string description: >- Identifier of a PayPal billing agreement. For example, I-1TJ3GAGG82Y9. email: type: string description: Email address associated with the payment method required: - baid - email paypalAdaptive: type: object title: PaypalAdaptive description: >- If it is a `paypal_adaptive` payment method, this hash contains details about the PayPal Adaptive payment method. additionalProperties: false properties: preapproval_key: type: string description: PayPal preapproval key. example: 2G4EPFSD email: type: string description: Email address associated with the payment method. example: alawrence@zuora.com required: - preapproval_key - email paypalExpressNative: type: object title: PaypalExpressNative description: >- If it is a `paypal_express_native` payment method, this hash contains details about the PayPal Express Native payment method. additionalProperties: false properties: baid: type: string description: >- Identifier of a PayPal billing agreement. For example, I-1TJ3GAGG82Y9. email: type: string description: >- Email address associated with the payment method. This is required with a paypal_express_checkout or a paypal_adaptive payment method. required: - baid nzBecsDebit: type: object title: NzBecsDebit description: >- If the `type` of the payment method is `nz_becs_debit`, this hash contains details about the BECS-NZ bank account. additionalProperties: false properties: account_number: type: string description: The bank account number of the account holder. branch_code: type: string description: Identifier of the bank branch associated with this bank account. bank_code: type: string description: Identifier of the bank associated with this bank account. mandate: type: object title: Mandate description: >- The mandate information for the Credit Card, Credit Card Reference Transaction, ACH, or Bank Transfer payment method. additionalProperties: false properties: id: type: string description: >- Identifier of the single- or multi-use mandate generated by the payment gateway. reason: type: string description: Reason for the mandate. state: type: string enum: - active - canceled - expired - agreed readOnly: true description: >- The status of the mandate, which indicates whether it can be used to initiate a payment. required: - account_number - branch_code - bank_code padDebit: type: object title: PadDebit description: >- If the `type` of the payment method is `pad_debit`, this hash contains details about the PAD bank account. additionalProperties: false properties: account_number: type: string description: The bank account number of the account holder. branch_code: type: string description: Identifier of the bank branch associated with this bank account. bank_code: type: string description: Identifier of the bank associated with this bank account. mandate: type: object title: Mandate description: >- The mandate information for the Credit Card, Credit Card Reference Transaction, ACH, or Bank Transfer payment method. additionalProperties: false properties: id: type: string description: >- Identifier of the single- or multi-use mandate generated by the payment gateway. reason: type: string description: Reason for the mandate. state: type: string enum: - active - canceled - expired - agreed readOnly: true description: >- The status of the mandate, which indicates whether it can be used to initiate a payment. required: - account_number - branch_code - bank_code auBecsDebit: type: object title: AuBecsDebit description: >- If the `type` of the payment method is `au_becs_debit`, this hash contains details about the BECS bank account. additionalProperties: false properties: account_number: type: string description: The bank account number of the account holder. branch_code: type: string description: Identifier of the bank branch associated with this bank account. mandate: type: object title: Mandate description: >- The mandate information for the Credit Card, Credit Card Reference Transaction, ACH, or Bank Transfer payment method. additionalProperties: false properties: id: type: string description: >- Identifier of the single- or multi-use mandate generated by the payment gateway. reason: type: string description: Reason for the mandate. state: type: string enum: - active - canceled - expired - agreed readOnly: true description: >- The status of the mandate, which indicates whether it can be used to initiate a payment. required: - account_number - branch_code bacsDebit: type: object title: BacsDebit description: >- If the `type` of the payment method is `bacs_debit`,, this hash contains details about the BACS bank account. additionalProperties: false properties: account_number: type: string description: The bank account number of the account holder. bank_code: type: string description: Identifier of the bank associated with this bank account. mandate: type: object title: Mandate description: >- The mandate information for the Credit Card, Credit Card Reference Transaction, ACH, or Bank Transfer payment method. additionalProperties: false properties: id: type: string description: >- Identifier of the single- or multi-use mandate generated by the payment gateway. reason: type: string description: Reason for the mandate. state: type: string enum: - active - canceled - expired - agreed readOnly: true description: >- The status of the mandate, which indicates whether it can be used to initiate a payment. required: - account_number - bank_code autogiroDebit: type: object title: AutogiroDebit description: >- If the `type` of the payment method is `autogiro_debit`, this hash contains details about the Autogiro bank account. additionalProperties: false properties: account_number: type: string description: The bank account number of the account holder. identity_number: type: string description: The identity number used for Autogiro (Direct Debit SE). branch_code: type: string description: Identifier of the bank branch associated with this bank account. mandate: type: object title: Mandate description: >- The mandate information for the Credit Card, Credit Card Reference Transaction, ACH, or Bank Transfer payment method. additionalProperties: false properties: id: type: string description: >- Identifier of the single- or multi-use mandate generated by the payment gateway. reason: type: string description: Reason for the mandate. state: type: string enum: - active - canceled - expired - agreed readOnly: true description: >- The status of the mandate, which indicates whether it can be used to initiate a payment. required: - account_number - identity_number - branch_code betalingsDebit: type: object title: BetalingsDebit description: >- If the `type` of the payment method is `betalings_debit`, this hash contains details about the Betalingsservice bank account. additionalProperties: false properties: account_number: type: string description: The bank account number of the account holder. identity_number: type: string description: The identity number used for Betalingsservice (Direct Debit DK). bank_code: type: string description: Identifier of the bank associated with this bank account. mandate: type: object title: Mandate description: >- The mandate information for the Credit Card, Credit Card Reference Transaction, ACH, or Bank Transfer payment method. additionalProperties: false properties: id: type: string description: >- Identifier of the single- or multi-use mandate generated by the payment gateway. reason: type: string description: Reason for the mandate. state: type: string enum: - active - canceled - expired - agreed readOnly: true description: >- The status of the mandate, which indicates whether it can be used to initiate a payment. required: - account_number - identity_number - bank_code achDebit: type: object title: AchDebit description: >- If the `type` of the payment method is `ach_debit`, this hash contains details about the ACH bank account. additionalProperties: false properties: mandate: type: object title: Mandate description: >- The mandate information for the Credit Card, Credit Card Reference Transaction, ACH, or Bank Transfer payment method. additionalProperties: false properties: id: type: string description: >- Identifier of the single- or multi-use mandate generated by the payment gateway. reason: type: string description: Reason for the mandate. state: type: string enum: - active - canceled - expired - agreed readOnly: true description: >- The status of the mandate, which indicates whether it can be used to initiate a payment. bank_aba_code: type: string description: The nine-digit routing number or ABA number used by banks. bank_account_name: type: string description: >- The name of the account holder, which can be either a person or a company. bank_account_type: type: string enum: - business_saving - business_checking - checking - saving description: The type of bank account associated with the payment method. bank_name: type: string description: Name of the bank associated with this bank account. bank_account_number: type: string description: The bank account number of the account holder. required: - bank_aba_code - bank_account_type - bank_account_name - bank_account_number - bank_name achDebitUpdate: type: object title: AchDebitUpdate description: '' nullable: false additionalProperties: false properties: mandate: $ref: '#/components/schemas/mandate' bank_aba_code: type: string description: The nine-digit routing number or ABA number used by banks. bank_account_name: type: string description: >- The name of the account holder, which can be either a person or a company. bank_account_type: type: string enum: - business_saving - business_checking - checking - saving description: The type of bank account associated with the payment method. bank_name: type: string description: Name of the bank associated with this bank account. sepaDebit: type: object title: SepaDebit description: >- If the `type` of the payment method is `sepa_debit`, this hash contains details about the SEPA bank account. additionalProperties: false properties: IBAN: type: string description: >- International Bank Account Number used to create the SEPA Debit payment method. mandate: type: object title: Mandate description: >- The mandate information for the Credit Card, Credit Card Reference Transaction, ACH, or Bank Transfer payment method. additionalProperties: false properties: id: type: string description: >- Identifier of the single- or multi-use mandate generated by the payment gateway. reason: type: string description: Reason for the mandate. state: type: string enum: - active - canceled - expired - agreed readOnly: true description: >- The status of the mandate, which indicates whether it can be used to initiate a payment. business_identification_code: type: string description: The BIC code used with the Sepa Debit payment method. required: - IBAN ccRefCard: type: object title: CcRefCard description: '' nullable: false additionalProperties: false properties: brand: type: string enum: - visa - mastercard - american_express - discover - jcb - diners description: Card brand. expiry_month: type: number description: One or two digit expiration month (1-12) of the credit card. example: 10 expiry_year: type: number description: Two- or four-digit number representing the card's expiration year. example: 2024 last_4: type: string readOnly: true description: The last four digits of the card number. example: '2042' ccRef: type: object title: CcRef description: >- If the `type` of the payment method is `cc_ref`, this hash contains details about the Credit Card Reference Transactions payment method. See [Supported payment methods](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/A_Supported_Payment_Methods) for payment gateways that support this type of payment method. additionalProperties: false properties: second_token: type: string description: >- A gateway unique identifier that replaces sensitive payment method data. This field is conditionally required only when `token` is being used to represent a gateway customer profile. token: type: string description: >- A gateway unique identifier that replaces sensitive payment method data or represents a gateway's unique customer profile. When `token` is used to represent a customer profile, `second_token` is conditionally required for representing the underlying tokenized payment method. mandate: type: object title: Mandate description: >- The mandate information for the Credit Card, Credit Card Reference Transaction, ACH, or Bank Transfer payment method. additionalProperties: false properties: id: type: string description: >- Identifier of the single- or multi-use mandate generated by the payment gateway. reason: type: string description: Reason for the mandate. state: type: string enum: - active - canceled - expired - agreed readOnly: true description: >- The status of the mandate, which indicates whether it can be used to initiate a payment. card: type: object title: CcRefCard description: '' nullable: false additionalProperties: false properties: brand: type: string enum: - visa - mastercard - american_express - discover - jcb - diners description: Card brand. expiry_month: type: number description: One or two digit expiration month (1-12) of the credit card. example: 10 expiry_year: type: number description: >- Two- or four-digit number representing the card's expiration year. example: 2024 last_4: type: string readOnly: true description: The last four digits of the card number. example: '2042' required: - token ccRefUpdate: type: object title: CcRefUpdate description: >- If the `type` of the payment method is `cc_ref`, this hash contains details about the Credit Card Reference Transactions payment method. See [Supported payment methods](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/A_Supported_Payment_Methods) for payment gateways that support this type of payment method. additionalProperties: false properties: second_token: type: string description: >- A gateway unique identifier that replaces sensitive payment method data. This field is conditionally required only when `token` is being used to represent a gateway customer profile. mandate: $ref: '#/components/schemas/mandate' card: type: object title: Card description: >- Credit card information. When providing a card number, you must meet the requirements for PCI compliance. We strongly recommend using Zuora's [Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0) instead of interacting with this API directly. additionalProperties: false properties: card_number: type: string writeOnly: true description: The card number, as a string without any separators. example: '4001100010112042' brand: type: string enum: - visa - mastercard - american_express - discover - jcb - diners description: Card brand. expiry_month: type: number description: One or two digit expiration month (1-12) of the credit card. example: 10 expiry_year: type: number description: Two- or four-digit number representing the card's expiration year. example: 2024 security_code: type: string description: >- Card security code. It is highly recommended to always include this value. example: '111' mandate: $ref: '#/components/schemas/cardMandate' last_4: type: string readOnly: true description: The last four digits of the card number. example: '2042' required: - card_number - brand - expiry_month - expiry_year getCardList: type: object title: GetCardList description: Credit card information. additionalProperties: false properties: brand: type: string enum: - visa - mastercard - american_express - discover - jcb - diners description: Card brand. expiry_month: type: number description: One or two digit expiration month (1-12) of the credit card. example: 10 expiry_year: type: number description: Two- or four-digit number representing the card's expiration year. example: 2024 mandate: type: object title: Mandate description: >- The mandate information for the Credit Card, Credit Card Reference Transaction, ACH, or Bank Transfer payment method. additionalProperties: false properties: id: type: string description: >- Identifier of the single- or multi-use mandate generated by the payment gateway. reason: type: string description: Reason for the mandate. state: type: string enum: - active - canceled - expired - agreed readOnly: true description: >- The status of the mandate, which indicates whether it can be used to initiate a payment. last_4: type: string readOnly: true description: The last four digits of the card number. example: '2042' applePay: type: object title: ApplePay description: >- If the `type` of the payment method is `apple_pay`, this hash contains details about the Apple Pay payment method. See [Supported payment methods](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/A_Supported_Payment_Methods) for payment gateways that support this type of payment method. additionalProperties: false properties: card: allOf: - $ref: '#/components/schemas/getCardList' description: >- Credit card information. When providing a card number, you must meet the requirements for PCI compliance. We strongly recommend using Zuora.js instead of interacting with this API directly. mandate: type: object title: Mandate description: >- The mandate information for the Credit Card, Credit Card Reference Transaction, ACH, or Bank Transfer payment method. additionalProperties: false properties: id: type: string description: >- Identifier of the single- or multi-use mandate generated by the payment gateway. reason: type: string description: Reason for the mandate. state: type: string enum: - active - canceled - expired - agreed readOnly: true description: >- The status of the mandate, which indicates whether it can be used to initiate a payment. payment_id: type: string description: >- The ID of newly processed payment. Only available in the response of the Create Payment Method API request. token: type: string description: >- A gateway unique identifier that replaces sensitive payment method data or represents a gateway's unique customer profile. When `token` is used to represent a customer profile, `second_token` is conditionally required for representing the underlying tokenized payment method. cardUpdate: type: object title: CardUpdate description: >- If the `type` of the payment method is `card`, this hash contains details about the Credit Card payment method. When providing a card number, you must meet the requirements for PCI compliance. We strongly recommend using Zuora's [Payment Pages 2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0) instead of interacting with this API directly. additionalProperties: false properties: expiry_month: type: number description: One- or two-digit expiration month (1-12) of the credit card. expiry_year: type: number description: Two- or four-digit number representing the card's expiration year. security_code: type: string description: >- Card security code. It is highly recommended to always include this value. applePayCreate: type: object title: ApplePayCreate description: >- If the `type` of the payment method is `apple_pay`, this hash contains details about the Apple Pay payment method. See [Supported payment methods](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/A_Supported_Payment_Methods) for payment gateways that support this type of payment method. additionalProperties: false properties: id: type: string description: >- The Merchant ID that was configured for use with Apple Pay in the Apple iOS Developer Center. customer_token: type: object additionalProperties: true description: >- The complete JSON Object representing the encrypted payment token payload returned in the response from the Apple Pay session. collect_payment: type: boolean description: > A boolean flag to control whether a payment should be processed after creating payment method. The payment amount will be equivalent to the amount the merchant supplied in the ApplePay session. Default is false. If this field is set to `true`, you must specify the `gateway_id` field with the payment gateway instance name. If this field is set to `false`: - The default payment gateway of your Zuora customer account will be used no matter whether a payment gateway instance is specified in the `gateway_id` field. - You must select the **Verify new credit card** check box on the gateway instance settings page. Otherwise, the cryptogram will not be sent to the gateway. - A separate subscribe or payment API call is required after this payment method creation call. invoice_id: type: string description: >- The id of invoice this payment will apply to. Note: When `collect_payment` is true, this field is required. Only one invoice can be paid; for scenarios where you want to pay for multiple invoices, set collect_payment to false and use [Create Payment](#operation/createPayment) API separately. mandate: $ref: '#/components/schemas/mandate' required: - customer_token googlePayCreate: type: object title: GooglePayCreate description: >- If the `type` of the payment method is `google_pay`, this hash contains details about the Google Pay payment method. See [Supported payment methods](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/A_Supported_Payment_Methods) for payment gateways that support this type of payment method. additionalProperties: false properties: customer_token: type: object additionalProperties: true description: >- The complete JSON Object representing the encrypted payment token payload returned in the response from the Google Pay session. required: - customer_token googlePay: type: object title: GooglePay description: >- If the `type` of the payment method is `apple_pay`, this hash contains details about the Apple Pay payment method. See [Supported payment methods](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/A_Supported_Payment_Methods) for payment gateways that support this type of payment method. additionalProperties: false properties: card: allOf: - $ref: '#/components/schemas/getCardList' description: >- Credit card information. When providing a card number, you must meet the requirements for PCI compliance. We strongly recommend using Zuora.js instead of interacting with this API directly. token: type: string description: >- A gateway unique identifier that replaces sensitive payment method data or represents a gateway's unique customer profile. When `token` is used to represent a customer profile, `second_token` is conditionally required for representing the underlying tokenized payment method. addressFieldDefinitions: type: object title: AddressFieldDefinitions description: Address information used in billing details. additionalProperties: false properties: line1: type: string description: Address line 1 (e.g., street, PO Box, or company name). example: 3333 Piedmont Rd NE line2: type: string description: Address line 2 (e.g., apartment, suite, unit, or building). example: Suite 1150 city: type: string description: City, district, suburb, town, or village. example: Atlanta country: type: string description: The country of the contact's address. example: United States state: type: string description: The state, county, province, or region. example: GA postal_code: type: string description: ZIP or postal code. example: '30305' billingDetails: type: object title: BillingDetails description: >- Billing information associated with the payment method that may be used or required by specific payment method types. additionalProperties: false properties: name: type: string description: Customer full name or business name. example: Amy Lawrence address: type: object title: AddressFieldDefinitions description: Address information used in billing details. additionalProperties: false properties: line1: type: string description: Address line 1 (e.g., street, PO Box, or company name). example: 3333 Piedmont Rd NE line2: type: string description: Address line 2 (e.g., apartment, suite, unit, or building). example: Suite 1150 city: type: string description: City, district, suburb, town, or village. example: Atlanta country: type: string description: The country of the contact's address. example: United States state: type: string description: The state, county, province, or region. example: GA postal_code: type: string description: ZIP or postal code. example: '30305' email: type: string description: Customer email address. example: alawrence@gmail.com phone: type: string description: Customer phone (including extension). example: (888)976-9056 account: type: object title: Account description: The account data. additionalProperties: false properties: id: type: string readOnly: true description: Unique identifier for the object. updated_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who last updated the object updated_time: type: string format: date-time readOnly: true description: >- The date and time when the object was last updated in ISO 8601 UTC format. created_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who created the object created_time: type: string format: date-time readOnly: true description: >- The date and time when the object was created in ISO 8601 UTC format. custom_fields: type: object title: CustomFields description: >- Set of user-defined fields associated with this object. Useful for storing additional information about the object in a structured format. x-extra-field-annotation: '@JsonAdapter(CustomFieldAdapter.class)' additionalProperties: true custom_objects: oneOf: - $ref: '#/components/schemas/listCustomObjectResponse' - $ref: '#/components/schemas/custom_object' readOnly: true description: The custom objects associated with a Zuora standard object. account_number: type: string description: Human-readable identifier of the account. It can be user-supplied. example: A-100001 billing_document_settings: type: object title: BillingDocumentSettings description: Billing document settings for an account additionalProperties: false properties: credit_memo_template_id: type: string description: >- Identifier of the credit memo template associated with this customer. example: 2c92c08b6a8c978f016a9e0084622b62 debit_memo_template_id: type: string description: >- Identifier of the debit memo template associated with this customer. example: 2c92c08c6a8c7e08016a9ec8d72f3ab5 email_documents: type: boolean description: Whether the customer wants to receive email invoices. example: alawrence@zuora.com print_documents: type: boolean description: Whether the customer wants to receive printed invoices. example: false invoice_template_id: type: string description: >- Identifier of the invoice template associated with this customer. example: 8f64d4d754739d85d0346e00ef77e50d additional_email: type: array items: type: string description: >- A list of additional email addresses to receive email notifications. example: jdoe@zuora.com batch: type: string description: The identifier of a bill run batch. bill_cycle_day: type: integer minimum: 0 maximum: 31 description: >- The day of the month on which your customer will be invoiced. For month-end specify 31. bill_to: allOf: - $ref: '#/components/schemas/contact' readOnly: true description: Customer billing address. sold_to: allOf: - $ref: '#/components/schemas/contact' readOnly: true description: Customer address used for calculating tax. communication_profile_id: type: string description: >- Identifier of the communication profile associated with this customer. example: 2c92c0946a6dffc0016a7faab604299b crm_id: type: string description: CRM account identifier. example: 1a2b3c4d5e default_payment_method_id: type: string description: Identifier of the default payment method on the customer account. example: 8a95b1946b6aeac8718c32aab8c395f name: type: string description: The name of the customer account. example: test account description: type: string description: >- An arbitrary string attached to the object. Often useful for displaying to users. example: description of test account parent_account_id: type: string description: Identifier of this customer's parent account, if any. example: 8ad093f27d6eee80017d6effd7a66759 payment_gateway: type: string description: Payment gateway name. example: adyen gateway payment_terms: type: string description: >- Payment terms configured in **Billing Settings > Payment Terms** of your Zuora tenant. example: Net 30 sequence_set_id: type: string description: >- The identifier or the billing document sequence set that is assigned to the customer account. example: 2c92a4204a6dffc0016a7faab723041c auto_pay: type: boolean description: >- Controls whether future payments are automatically billed when they are due. example: true tax_certificate: type: object title: TaxCertificate description: The tax certificate information. additionalProperties: false properties: company_code: type: string description: >- Unique code that identifies a company account in Avalara. Use this field to calculate taxes based on country of origin and sold-to addresses in Avalara. example: ABC id: type: string description: Identifier of the tax exemption certificate. start_date: type: string format: date description: The tax certificate start date. example: '2022-01-01' description: type: string description: Description of the tax exemption certificate. entity_use_code: type: string description: >- A unique entity use code used by Avalara to apply exemptions. This field is required only when you choose Avalara as your tax engine. See [Exempt Transactions](https://developer.avalara.com/avatax/handling-tax-exempt-customers/) for more information. end_date: type: string format: date description: The tax certificate end date. example: '2023-01-01' issuing_jurisdiction: type: string description: Typically, this is a state or government agency example: Georgia state: type: string enum: - pending - verified - not_valid description: >- Status of the tax exemption certificate, indication whether the certificate has been verified. tax_identifier: type: string deprecated: true description: >- Value Added Tax (VAT) ID. Each VAT ID must begin with the code of the country code and followed by a block of digits or characters. example: DE123456789 tax_identifier: type: object title: TaxIdentifier description: An object that contains the VAT Identification number. additionalProperties: false properties: id: type: string description: >- Value Added Tax (VAT) ID. Each VAT ID must begin with the code of the country code and followed by a block of digits or characters. currency: type: string description: >- Three-letter ISO currency code. Once the currency is set for an account, it cannot be updated. example: USD sales_rep: type: string description: The name of the sales representative associated with this account example: Max enabled: type: boolean readOnly: true description: >- Usually used to disable the customer account. The default is true. If false, attempts to create subscriptions for the customer account will fail. example: true remaining_debit_memo_balance: type: number readOnly: true description: Total remaining balance of all posted debit memos. example: 10 remaining_invoice_balance: type: number readOnly: true description: Total remaining balance of all posted invoices. example: 100 remaining_credit_memo_balance: type: number readOnly: true description: Total remaining balance of all posted credit memos. example: 50 remaining_payment_balance: type: number readOnly: true description: Total remaining balance of all posted payments. example: 20 bill_to_id: type: string description: Customer billing address. example: 2c92c0f86a8dd422016a9e7a70116b0d sold_to_id: type: string description: Customer address used for calculating tax. example: 8ad0823f8040e52d0180433026b156fe default_payment_method: allOf: - $ref: '#/components/schemas/paymentMethod' description: The default payment method for the customer. billing_documents: allOf: - $ref: '#/components/schemas/billingDocumentListResponse' readOnly: true description: List of customer billing documents. payments: allOf: - $ref: '#/components/schemas/paymentListResponse' readOnly: true description: List of customer payments. payment_methods: allOf: - $ref: '#/components/schemas/paymentMethodListResponse' readOnly: true description: List of customer payment methods. subscriptions: allOf: - $ref: '#/components/schemas/subscriptionListResponse' readOnly: true description: List of customer subscriptions. usage_records: allOf: - $ref: '#/components/schemas/listUsageResponse' readOnly: true description: List of customer usages. credit_memos: allOf: - $ref: '#/components/schemas/creditMemoListResponse' readOnly: true description: List of credit memo debit_memos: allOf: - $ref: '#/components/schemas/debitMemoListResponse' readOnly: true description: List of debit memo invoices: allOf: - $ref: '#/components/schemas/invoiceListResponse' readOnly: true description: List of invoices listAccountResponse: type: object title: ListAccountResponse description: '' nullable: false additionalProperties: false properties: next_page: type: string nullable: true data: type: array items: $ref: '#/components/schemas/account' listContactResponse: type: object title: ListContactResponse description: '' nullable: false additionalProperties: false properties: next_page: type: string nullable: true data: type: array items: $ref: '#/components/schemas/contact' paymentMethodAuthorizationResponse: type: object title: PaymentMethodAuthorizationResponse description: '' nullable: false additionalProperties: false properties: auth_transaction_id: type: string description: >- Identifier of the authorization transaction from the payment gateway. gateway_order_id: type: string description: >- A merchant-specified natural key value that can be passed to the electronic payment gateway when a payment is created. If not specified, the payment number will be passed in instead. Gateways check duplicates on the gateway order ID to ensure that the merchant do not accidentally enter the same transaction twice. This ID can also be used to do reconciliation and tie the payment to a natural key in external systems. The source of this ID varies by merchant. Some merchants use their shopping cart order IDs, and others use something different. Merchants use this ID to track transactions in their eCommerce systems. When you create a payment for capturing the authorized funds, it is highly recommended to pass in the `gateway_order_id` that you used when authorizing the funds by using the Create authorization operation, together with the `authorization_id` field. state: type: string enum: - approved - queued_for_submission description: The status of the payment authorization. authorizationMandate: type: object title: AuthorizationMandate description: '' nullable: false additionalProperties: false properties: type: type: string enum: - multi_use - single_use description: Indicates the type of mandate, if any. paymentMethod: type: object title: PaymentMethod description: Payment method information. additionalProperties: false properties: id: type: string readOnly: true description: Unique identifier for the object. updated_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who last updated the object updated_time: type: string format: date-time readOnly: true description: >- The date and time when the object was last updated in ISO 8601 UTC format. created_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who created the object created_time: type: string format: date-time readOnly: true description: >- The date and time when the object was created in ISO 8601 UTC format. custom_fields: type: object title: CustomFields description: >- Set of user-defined fields associated with this object. Useful for storing additional information about the object in a structured format. x-extra-field-annotation: '@JsonAdapter(CustomFieldAdapter.class)' additionalProperties: true custom_objects: oneOf: - $ref: '#/components/schemas/listCustomObjectResponse' - $ref: '#/components/schemas/custom_object' readOnly: true description: The custom objects associated with a Zuora standard object. type: type: string enum: - paypal_express - paypal_express_native - paypal_adaptive - card - cc_ref - ach_debit - sepa_debit - betalings_debit - autogiro_debit - bacs_debit - au_becs_debit - nz_becs_debit - pad_debit - apple_pay - wire_transfer - check - cash - other - paypal - adyen_google_pay - adyen_apple_pay description: >- The type of the payment method. An additional hash is included on the payment method with a name matching this value. It contains additional information specific to the payment method type. custom_type: type: string description: >- The custom type of the payment method from Universal Payment Connector. account_id: type: string description: A customer account identifier. example: 2c92c0f86a8dd422016a9e7a70116b0d account: allOf: - $ref: '#/components/schemas/account' readOnly: true description: The customer account associated with this payment method. billing_details: type: object title: BillingDetails description: >- Billing information associated with the payment method that may be used or required by specific payment method types. additionalProperties: false properties: name: type: string description: Customer full name or business name. example: Amy Lawrence address: type: object title: AddressFieldDefinitions description: Address information used in billing details. additionalProperties: false properties: line1: type: string description: Address line 1 (e.g., street, PO Box, or company name). example: 3333 Piedmont Rd NE line2: type: string description: Address line 2 (e.g., apartment, suite, unit, or building). example: Suite 1150 city: type: string description: City, district, suburb, town, or village. example: Atlanta country: type: string description: The country of the contact's address. example: United States state: type: string description: The state, county, province, or region. example: GA postal_code: type: string description: ZIP or postal code. example: '30305' email: type: string description: Customer email address. example: alawrence@gmail.com phone: type: string description: Customer phone (including extension). example: (888)976-9056 maximum_payment_attempts: type: number description: >- Maximum number of consecutive failed retry payment attempts using this payment method before retries are stopped. example: 6 payment_retry_interval: type: integer description: The retry interval in hours. example: 3 device_session_id: type: string ip_address: type: string nullable: true description: The IP address from which the Mandate was accepted by the customer. example: 192.10.1.123 bank_identification_number: type: string card: type: object title: GetCardList description: Credit card information. additionalProperties: false properties: brand: type: string enum: - visa - mastercard - american_express - discover - jcb - diners description: Card brand. expiry_month: type: number description: One or two digit expiration month (1-12) of the credit card. example: 10 expiry_year: type: number description: >- Two- or four-digit number representing the card's expiration year. example: 2024 mandate: type: object title: Mandate description: >- The mandate information for the Credit Card, Credit Card Reference Transaction, ACH, or Bank Transfer payment method. additionalProperties: false properties: id: type: string description: >- Identifier of the single- or multi-use mandate generated by the payment gateway. reason: type: string description: Reason for the mandate. state: type: string enum: - active - canceled - expired - agreed readOnly: true description: >- The status of the mandate, which indicates whether it can be used to initiate a payment. last_4: type: string readOnly: true description: The last four digits of the card number. example: '2042' paypal_express_native: type: object title: PaypalExpressNative description: >- If it is a `paypal_express_native` payment method, this hash contains details about the PayPal Express Native payment method. additionalProperties: false properties: baid: type: string description: >- Identifier of a PayPal billing agreement. For example, I-1TJ3GAGG82Y9. email: type: string description: >- Email address associated with the payment method. This is required with a paypal_express_checkout or a paypal_adaptive payment method. required: - baid paypal_express: type: object title: PaypalExpress description: >- If it is a `paypal_express` payment method, this hash contains details about the PayPal Express payment method. additionalProperties: false properties: baid: type: string description: >- Identifier of a PayPal billing agreement. For example, I-1TJ3GAGG82Y9. email: type: string description: Email address associated with the payment method required: - baid - email paypal_adaptive: type: object title: PaypalAdaptive description: >- If it is a `paypal_adaptive` payment method, this hash contains details about the PayPal Adaptive payment method. additionalProperties: false properties: preapproval_key: type: string description: PayPal preapproval key. example: 2G4EPFSD email: type: string description: Email address associated with the payment method. example: alawrence@zuora.com required: - preapproval_key - email sepa_debit: type: object title: SepaDebit description: >- If the `type` of the payment method is `sepa_debit`, this hash contains details about the SEPA bank account. additionalProperties: false properties: IBAN: type: string description: >- International Bank Account Number used to create the SEPA Debit payment method. mandate: type: object title: Mandate description: >- The mandate information for the Credit Card, Credit Card Reference Transaction, ACH, or Bank Transfer payment method. additionalProperties: false properties: id: type: string description: >- Identifier of the single- or multi-use mandate generated by the payment gateway. reason: type: string description: Reason for the mandate. state: type: string enum: - active - canceled - expired - agreed readOnly: true description: >- The status of the mandate, which indicates whether it can be used to initiate a payment. business_identification_code: type: string description: The BIC code used with the Sepa Debit payment method. required: - IBAN cc_ref: type: object title: CcRef description: >- If the `type` of the payment method is `cc_ref`, this hash contains details about the Credit Card Reference Transactions payment method. See [Supported payment methods](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/A_Supported_Payment_Methods) for payment gateways that support this type of payment method. additionalProperties: false properties: second_token: type: string description: >- A gateway unique identifier that replaces sensitive payment method data. This field is conditionally required only when `token` is being used to represent a gateway customer profile. token: type: string description: >- A gateway unique identifier that replaces sensitive payment method data or represents a gateway's unique customer profile. When `token` is used to represent a customer profile, `second_token` is conditionally required for representing the underlying tokenized payment method. mandate: type: object title: Mandate description: >- The mandate information for the Credit Card, Credit Card Reference Transaction, ACH, or Bank Transfer payment method. additionalProperties: false properties: id: type: string description: >- Identifier of the single- or multi-use mandate generated by the payment gateway. reason: type: string description: Reason for the mandate. state: type: string enum: - active - canceled - expired - agreed readOnly: true description: >- The status of the mandate, which indicates whether it can be used to initiate a payment. card: type: object title: CcRefCard description: '' nullable: false additionalProperties: false properties: brand: type: string enum: - visa - mastercard - american_express - discover - jcb - diners description: Card brand. expiry_month: type: number description: One or two digit expiration month (1-12) of the credit card. example: 10 expiry_year: type: number description: >- Two- or four-digit number representing the card's expiration year. example: 2024 last_4: type: string readOnly: true description: The last four digits of the card number. example: '2042' required: - token apple_pay: type: object title: ApplePay description: >- If the `type` of the payment method is `apple_pay`, this hash contains details about the Apple Pay payment method. See [Supported payment methods](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/A_Supported_Payment_Methods) for payment gateways that support this type of payment method. additionalProperties: false properties: card: allOf: - $ref: '#/components/schemas/getCardList' description: >- Credit card information. When providing a card number, you must meet the requirements for PCI compliance. We strongly recommend using Zuora.js instead of interacting with this API directly. mandate: type: object title: Mandate description: >- The mandate information for the Credit Card, Credit Card Reference Transaction, ACH, or Bank Transfer payment method. additionalProperties: false properties: id: type: string description: >- Identifier of the single- or multi-use mandate generated by the payment gateway. reason: type: string description: Reason for the mandate. state: type: string enum: - active - canceled - expired - agreed readOnly: true description: >- The status of the mandate, which indicates whether it can be used to initiate a payment. payment_id: type: string description: >- The ID of newly processed payment. Only available in the response of the Create Payment Method API request. token: type: string description: >- A gateway unique identifier that replaces sensitive payment method data or represents a gateway's unique customer profile. When `token` is used to represent a customer profile, `second_token` is conditionally required for representing the underlying tokenized payment method. google_pay: type: object title: GooglePay description: >- If the `type` of the payment method is `apple_pay`, this hash contains details about the Apple Pay payment method. See [Supported payment methods](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/A_Supported_Payment_Methods) for payment gateways that support this type of payment method. additionalProperties: false properties: card: allOf: - $ref: '#/components/schemas/getCardList' description: >- Credit card information. When providing a card number, you must meet the requirements for PCI compliance. We strongly recommend using Zuora.js instead of interacting with this API directly. token: type: string description: >- A gateway unique identifier that replaces sensitive payment method data or represents a gateway's unique customer profile. When `token` is used to represent a customer profile, `second_token` is conditionally required for representing the underlying tokenized payment method. ach_debit: type: object title: AchDebit description: >- If the `type` of the payment method is `ach_debit`, this hash contains details about the ACH bank account. additionalProperties: false properties: mandate: type: object title: Mandate description: >- The mandate information for the Credit Card, Credit Card Reference Transaction, ACH, or Bank Transfer payment method. additionalProperties: false properties: id: type: string description: >- Identifier of the single- or multi-use mandate generated by the payment gateway. reason: type: string description: Reason for the mandate. state: type: string enum: - active - canceled - expired - agreed readOnly: true description: >- The status of the mandate, which indicates whether it can be used to initiate a payment. bank_aba_code: type: string description: The nine-digit routing number or ABA number used by banks. bank_account_name: type: string description: >- The name of the account holder, which can be either a person or a company. bank_account_type: type: string enum: - business_saving - business_checking - checking - saving description: The type of bank account associated with the payment method. bank_name: type: string description: Name of the bank associated with this bank account. bank_account_number: type: string description: The bank account number of the account holder. required: - bank_aba_code - bank_account_type - bank_account_name - bank_account_number - bank_name betalings_debit: type: object title: BetalingsDebit description: >- If the `type` of the payment method is `betalings_debit`, this hash contains details about the Betalingsservice bank account. additionalProperties: false properties: account_number: type: string description: The bank account number of the account holder. identity_number: type: string description: The identity number used for Betalingsservice (Direct Debit DK). bank_code: type: string description: Identifier of the bank associated with this bank account. mandate: type: object title: Mandate description: >- The mandate information for the Credit Card, Credit Card Reference Transaction, ACH, or Bank Transfer payment method. additionalProperties: false properties: id: type: string description: >- Identifier of the single- or multi-use mandate generated by the payment gateway. reason: type: string description: Reason for the mandate. state: type: string enum: - active - canceled - expired - agreed readOnly: true description: >- The status of the mandate, which indicates whether it can be used to initiate a payment. required: - account_number - identity_number - bank_code autogiro_debit: type: object title: AutogiroDebit description: >- If the `type` of the payment method is `autogiro_debit`, this hash contains details about the Autogiro bank account. additionalProperties: false properties: account_number: type: string description: The bank account number of the account holder. identity_number: type: string description: The identity number used for Autogiro (Direct Debit SE). branch_code: type: string description: Identifier of the bank branch associated with this bank account. mandate: type: object title: Mandate description: >- The mandate information for the Credit Card, Credit Card Reference Transaction, ACH, or Bank Transfer payment method. additionalProperties: false properties: id: type: string description: >- Identifier of the single- or multi-use mandate generated by the payment gateway. reason: type: string description: Reason for the mandate. state: type: string enum: - active - canceled - expired - agreed readOnly: true description: >- The status of the mandate, which indicates whether it can be used to initiate a payment. required: - account_number - identity_number - branch_code bacs_debit: type: object title: BacsDebit description: >- If the `type` of the payment method is `bacs_debit`,, this hash contains details about the BACS bank account. additionalProperties: false properties: account_number: type: string description: The bank account number of the account holder. bank_code: type: string description: Identifier of the bank associated with this bank account. mandate: type: object title: Mandate description: >- The mandate information for the Credit Card, Credit Card Reference Transaction, ACH, or Bank Transfer payment method. additionalProperties: false properties: id: type: string description: >- Identifier of the single- or multi-use mandate generated by the payment gateway. reason: type: string description: Reason for the mandate. state: type: string enum: - active - canceled - expired - agreed readOnly: true description: >- The status of the mandate, which indicates whether it can be used to initiate a payment. required: - account_number - bank_code au_becs_debit: type: object title: AuBecsDebit description: >- If the `type` of the payment method is `au_becs_debit`, this hash contains details about the BECS bank account. additionalProperties: false properties: account_number: type: string description: The bank account number of the account holder. branch_code: type: string description: Identifier of the bank branch associated with this bank account. mandate: type: object title: Mandate description: >- The mandate information for the Credit Card, Credit Card Reference Transaction, ACH, or Bank Transfer payment method. additionalProperties: false properties: id: type: string description: >- Identifier of the single- or multi-use mandate generated by the payment gateway. reason: type: string description: Reason for the mandate. state: type: string enum: - active - canceled - expired - agreed readOnly: true description: >- The status of the mandate, which indicates whether it can be used to initiate a payment. required: - account_number - branch_code nz_becs_debit: type: object title: NzBecsDebit description: >- If the `type` of the payment method is `nz_becs_debit`, this hash contains details about the BECS-NZ bank account. additionalProperties: false properties: account_number: type: string description: The bank account number of the account holder. branch_code: type: string description: Identifier of the bank branch associated with this bank account. bank_code: type: string description: Identifier of the bank associated with this bank account. mandate: type: object title: Mandate description: >- The mandate information for the Credit Card, Credit Card Reference Transaction, ACH, or Bank Transfer payment method. additionalProperties: false properties: id: type: string description: >- Identifier of the single- or multi-use mandate generated by the payment gateway. reason: type: string description: Reason for the mandate. state: type: string enum: - active - canceled - expired - agreed readOnly: true description: >- The status of the mandate, which indicates whether it can be used to initiate a payment. required: - account_number - branch_code - bank_code pad_debit: type: object title: PadDebit description: >- If the `type` of the payment method is `pad_debit`, this hash contains details about the PAD bank account. additionalProperties: false properties: account_number: type: string description: The bank account number of the account holder. branch_code: type: string description: Identifier of the bank branch associated with this bank account. bank_code: type: string description: Identifier of the bank associated with this bank account. mandate: type: object title: Mandate description: >- The mandate information for the Credit Card, Credit Card Reference Transaction, ACH, or Bank Transfer payment method. additionalProperties: false properties: id: type: string description: >- Identifier of the single- or multi-use mandate generated by the payment gateway. reason: type: string description: Reason for the mandate. state: type: string enum: - active - canceled - expired - agreed readOnly: true description: >- The status of the mandate, which indicates whether it can be used to initiate a payment. required: - account_number - branch_code - bank_code state: type: string enum: - active - closed - scrubbed description: The state of the payment method. auto_generated: type: boolean use_default_retry_rule: type: boolean existing_mandate: type: boolean last_failed_sale_transaction_time: type: string format: date-time last_transaction_time: type: string format: date-time last_transaction_status: type: string number_of_consecutive_failures: type: integer total_number_of_processed_payments: type: integer total_number_of_error_payments: type: integer paymentMethodAuthorizationRequest: type: object title: PaymentMethodAuthorizationRequest description: '' additionalProperties: false properties: account_id: type: string description: >- A customer account identifier. Either `account_id` or `account_number` is required. example: 2c92c0f86a8dd422016a9e7a70116b0d account_number: type: string description: >- A Human-readable customer account identifier. Either `account_id` or `account_number` is required. example: RC-00000011 amount: type: number description: Amount to be authorized. gateway_id: type: string description: >- Identifier of the payment gateway that Zuora will use to authorize the payments that are made with this payment method. If you do not set this field, Zuora will use one of the following payment gateways instead: The default payment gateway of the customer account that owns the payment method, if the payment method is associated with a customer account or the default payment gateway of your Zuora tenant. example: 8ad093d07ae636bb017ae97518762aa3 gateway_options: type: object additionalProperties: type: string description: A hash containing gateway-specific parameters. example: key: value gateway_order_id: type: string description: >- A merchant-specified natural key value that can be passed to the electronic payment gateway when a payment is created. If not specified, the payment number will be passed in instead. Gateways check duplicates on the gateway order ID to ensure that the merchant do not accidentally enter the same transaction twice. This ID can also be used to do reconciliation and tie the payment to a natural key in external systems. The source of this ID varies by merchant. Some merchants use their shopping cart order IDs, and others use something different. Merchants use this ID to track transactions in their eCommerce systems. When you create a payment for capturing the authorized funds, it is highly recommended to pass in the `gateway_order_id` that you used when authorizing the funds by using the Create authorization operation, together with the `authorization_id` field. statement_descriptor: type: string description: A payment gateway-specific field used by Orbital, Vantiv and Verifi. statement_descriptor_phone: type: string description: A payment gateway-specific field used by Orbital, Vantiv and Verifi. mandate: $ref: '#/components/schemas/authorizationMandate' required: - amount - gateway_order_id paymentMethodVoidAuthorizationRequest: type: object title: PaymentMethodVoidAuthorizationRequest description: '' additionalProperties: false properties: account_id: type: string description: >- A customer account identifier. Either `account_id` or `account_number` is required. example: 2c92c0f86a8dd422016a9e7a70116b0d account_number: type: string description: >- A Human-readable customer account identifier. Either `account_id` or `account_number` is required. example: RC-00000011 gateway_id: type: string description: >- Identifier of the payment gateway that Zuora will use to authorize the payments that are made with this payment method. If you do not set this field, Zuora will use one of the following payment gateways instead: The default payment gateway of the customer account that owns the payment method, if the payment method is associated with a customer account or the default payment gateway of your Zuora tenant. example: 8ad093d07ae636bb017ae97518762aa3 gateway_options: type: object additionalProperties: type: string description: A hash containing gateway-specific parameters. example: key: value gateway_order_id: type: string description: >- A merchant-specified natural key value that can be passed to the electronic payment gateway when a payment is created. If not specified, the payment number will be passed in instead. Gateways check duplicates on the gateway order ID to ensure that the merchant do not accidentally enter the same transaction twice. This ID can also be used to do reconciliation and tie the payment to a natural key in external systems. The source of this ID varies by merchant. Some merchants use their shopping cart order IDs, and others use something different. Merchants use this ID to track transactions in their eCommerce systems. When you create a payment for capturing the authorized funds, it is highly recommended to pass in the `gateway_order_id` that you used when authorizing the funds by using the Create authorization operation, together with the `authorization_id` field. auth_transaction_id: type: string description: >- Identifier of the authorization transaction from the payment gateway. required: - auth_transaction_id - gateway_order_id paymentMethodListResponse: type: object title: PaymentMethodListResponse description: '' nullable: false additionalProperties: false properties: next_page: type: string nullable: true data: type: array items: $ref: '#/components/schemas/paymentMethod' paymentMethodCreateRequest: type: object title: PaymentMethodCreateRequest description: '' additionalProperties: false properties: id: type: string readOnly: true description: Unique identifier for the object. updated_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who last updated the object updated_time: type: string format: date-time readOnly: true description: >- The date and time when the object was last updated in ISO 8601 UTC format. created_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who created the object created_time: type: string format: date-time readOnly: true description: >- The date and time when the object was created in ISO 8601 UTC format. custom_fields: $ref: '#/components/schemas/customFields' custom_objects: oneOf: - $ref: '#/components/schemas/listCustomObjectResponse' - $ref: '#/components/schemas/custom_object' readOnly: true description: The custom objects associated with a Zuora standard object. type: type: string enum: - paypal_express - paypal_express_native - paypal_adaptive - card - cc_ref - ach_debit - sepa_debit - betalings_debit - autogiro_debit - bacs_debit - au_becs_debit - nz_becs_debit - pad_debit - apple_pay - other - paypal - adyen_google_pay - adyen_apple_pay description: >- The type of the payment method. An additional hash is included on the payment method with a name matching this value. It contains additional information specific to the payment method type. custom_type: type: string description: >- The custom type of the payment method from Universal Payment Connector. account_id: type: string description: A customer account identifier. example: 2c92c0f86a8dd422016a9e7a70116b0d account: allOf: - $ref: '#/components/schemas/account' readOnly: true description: The customer account associated with this payment method. billing_details: $ref: '#/components/schemas/billingDetails' maximum_payment_attempts: type: number description: >- Maximum number of consecutive failed retry payment attempts using this payment method before retries are stopped. example: 6 payment_retry_interval: type: integer description: The retry interval in hours. example: 3 device_session_id: type: string description: Identifier of the device browser session. example: 2cadffe03 ip_address: type: string nullable: true description: The IP address from which the Mandate was accepted by the customer. example: 192.10.1.123 bank_identification_number: type: string description: >- The first six or eight digits of the payment method's number, such as the credit card number or account number. Banks use this number to identify a payment method. example: '123456' card: $ref: '#/components/schemas/card' paypal_express_native: $ref: '#/components/schemas/paypalExpressNative' paypal_express: $ref: '#/components/schemas/paypalExpress' paypal_adaptive: $ref: '#/components/schemas/paypalAdaptive' sepa_debit: $ref: '#/components/schemas/sepaDebit' cc_ref: $ref: '#/components/schemas/ccRef' apple_pay: $ref: '#/components/schemas/applePayCreate' google_pay: $ref: '#/components/schemas/googlePayCreate' ach_debit: $ref: '#/components/schemas/achDebit' betalings_debit: $ref: '#/components/schemas/betalingsDebit' autogiro_debit: $ref: '#/components/schemas/autogiroDebit' bacs_debit: $ref: '#/components/schemas/bacsDebit' au_becs_debit: $ref: '#/components/schemas/auBecsDebit' nz_becs_debit: $ref: '#/components/schemas/nzBecsDebit' pad_debit: $ref: '#/components/schemas/padDebit' account_number: type: string description: >- A human-readable customer account identifier. It can be user-supplied. example: A-100001 is_default: type: boolean description: >- Indicates whether it is the default payment method on the associated account. example: false gateway_id: type: string description: >- Identifier of the payment gateway Zuora will use to authorize the payments that are made with this payment method. example: 8ad093d07ae636bb017ae97518762aa3 gateway_options: type: object additionalProperties: type: string example: key: value required: - type paymentMethodPatchRequest: type: object title: PaymentMethodPatchRequest description: '' nullable: false additionalProperties: false properties: billing_details: $ref: '#/components/schemas/billingDetails' account_id: type: string description: A customer account identifier. example: 2c92c0f86a8dd422016a9e7a70116b0d account_number: type: string description: >- A human-readable customer account identifier. It can be user-supplied. example: A-100001 custom_fields: $ref: '#/components/schemas/customFields' card: allOf: - $ref: '#/components/schemas/cardUpdate' description: >- Credit card information. When providing a card number, you must meet the requirements for PCI compliance. We strongly recommend using Zuora.js instead of interacting with this API directly. cc_ref: allOf: - $ref: '#/components/schemas/ccRefUpdate' description: >- Credit Card Reference Transaction. See Supported payment methods for payment gateways that support this type of payment method. mandate: allOf: - $ref: '#/components/schemas/ccRefMandate' ach_debit: allOf: - $ref: '#/components/schemas/achDebitUpdate' description: >- If this is an ach_debit payment method, this hash contains details about the ACH debit bank account. maximum_payment_attempts: type: number description: >- Maximum number of consecutive failed retry payment attempts using this payment method before retries are stopped. example: 6 payment_retry_interval: type: integer description: The retry interval in hours. example: 3 device_session_id: type: string description: Identifier of the device browser session. example: 2cadffe03 gateway_options: type: object additionalProperties: type: string example: key: value currency: type: string description: 3-letter ISO 4217 currency code. gateway_id: type: string description: >- Identifier of the payment gateway Zuora will use to authorize the payments that are made with this payment method. accountPaymentMethodRequest: type: object title: AccountPaymentMethodRequest description: '' nullable: false additionalProperties: false properties: id: type: string readOnly: true description: Unique identifier for the object. updated_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who last updated the object updated_time: type: string format: date-time readOnly: true description: >- The date and time when the object was last updated in ISO 8601 UTC format. created_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who created the object created_time: type: string format: date-time readOnly: true description: >- The date and time when the object was created in ISO 8601 UTC format. custom_fields: $ref: '#/components/schemas/customFields' custom_objects: oneOf: - $ref: '#/components/schemas/listCustomObjectResponse' - $ref: '#/components/schemas/custom_object' readOnly: true description: The custom objects associated with a Zuora standard object. type: type: string enum: - paypal_express - paypal_express_native - paypal_adaptive - card - cc_ref - ach_debit - sepa_debit - betalings_debit - autogiro_debit - bacs_debit - au_becs_debit - nz_becs_debit - pad_debit - apple_pay - wire_transfer - check - cash - other - paypal - adyen_google_pay - adyen_apple_pay description: >- The type of the payment method. An additional hash is included on the payment method with a name matching this value. It contains additional information specific to the payment method type. custom_type: type: string description: >- The custom type of the payment method from Universal Payment Connector. account_id: type: string description: A customer account identifier. example: 2c92c0f86a8dd422016a9e7a70116b0d account: allOf: - $ref: '#/components/schemas/account' readOnly: true description: The customer account associated with this payment method. billing_details: $ref: '#/components/schemas/billingDetails' maximum_payment_attempts: type: number description: >- Maximum number of consecutive failed retry payment attempts using this payment method before retries are stopped. example: 6 payment_retry_interval: type: integer description: The retry interval in hours. example: 3 device_session_id: type: string description: Identifier of the device browser session. example: 2cadffe03 ip_address: type: string nullable: true description: The IP address from which the Mandate was accepted by the customer. example: 192.10.1.123 bank_identification_number: type: string description: >- The first six or eight digits of the payment method's number, such as the credit card number or account number. Banks use this number to identify a payment method. example: '123456' card: $ref: '#/components/schemas/card' paypal_express_native: $ref: '#/components/schemas/paypalExpressNative' paypal_express: $ref: '#/components/schemas/paypalExpress' paypal_adaptive: $ref: '#/components/schemas/paypalAdaptive' sepa_debit: $ref: '#/components/schemas/sepaDebit' cc_ref: $ref: '#/components/schemas/ccRef' apple_pay: $ref: '#/components/schemas/applePay' google_pay: $ref: '#/components/schemas/googlePay' ach_debit: $ref: '#/components/schemas/achDebit' betalings_debit: $ref: '#/components/schemas/betalingsDebit' autogiro_debit: $ref: '#/components/schemas/autogiroDebit' bacs_debit: $ref: '#/components/schemas/bacsDebit' au_becs_debit: $ref: '#/components/schemas/auBecsDebit' nz_becs_debit: $ref: '#/components/schemas/nzBecsDebit' pad_debit: $ref: '#/components/schemas/padDebit' paymentMethodVerificationRequest: type: object title: PaymentMethodVerificationRequest description: '' nullable: false additionalProperties: false properties: currency: type: string description: Three-letter ISO currency code. security_code: type: string description: Card security code. payment_gateway: type: string description: >- The name of the payment gateway instance. If no value is specified for this field, the default payment gateway of your Zuora tenant will be used. example: 8ad093d07ae636bb017ae97518762aa3 gateway_options: type: object additionalProperties: type: string description: A hash containing gateway-specific parameters. example: key: value accountPatchRequest: type: object title: AccountPatchRequest description: '' nullable: false additionalProperties: false properties: id: type: string readOnly: true description: Unique identifier for the object. updated_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who last updated the object updated_time: type: string format: date-time readOnly: true description: >- The date and time when the object was last updated in ISO 8601 UTC format. created_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who created the object created_time: type: string format: date-time readOnly: true description: >- The date and time when the object was created in ISO 8601 UTC format. custom_fields: $ref: '#/components/schemas/customFields' custom_objects: oneOf: - $ref: '#/components/schemas/listCustomObjectResponse' - $ref: '#/components/schemas/custom_object' readOnly: true description: The custom objects associated with a Zuora standard object. account_number: type: string description: Human-readable identifier of the account. It can be user-supplied. example: A-100001 billing_document_settings: $ref: '#/components/schemas/billingDocumentSettings' batch: type: string description: The identifier of a bill run batch. bill_cycle_day: type: integer minimum: 0 maximum: 31 description: >- The day of the month on which your customer will be invoiced. For month-end specify 31. bill_to: allOf: - $ref: '#/components/schemas/accountContactPatchRequest' description: Customer billing address. sold_to: allOf: - $ref: '#/components/schemas/accountContactPatchRequest' description: Customer address used for calculating tax. communication_profile_id: type: string description: >- Identifier of the communication profile associated with this customer. example: 2c92c0946a6dffc0016a7faab604299b crm_id: type: string description: CRM account identifier. example: 1a2b3c4d5e default_payment_method_id: type: string description: Identifier of the default payment method on the customer account. example: 8a95b1946b6aeac8718c32aab8c395f name: type: string description: The name of the customer account. example: test account description: type: string description: >- An arbitrary string attached to the object. Often useful for displaying to users. example: description of test account parent_account_id: type: string description: Identifier of this customer's parent account, if any. example: 8ad093f27d6eee80017d6effd7a66759 payment_gateway: type: string description: Payment gateway name. example: adyen gateway payment_terms: type: string description: >- Payment terms configured in **Billing Settings > Payment Terms** of your Zuora tenant. example: Net 30 sequence_set_id: type: string description: >- The identifier or the billing document sequence set that is assigned to the customer account. example: 2c92a4204a6dffc0016a7faab723041c auto_pay: type: boolean description: >- Controls whether future payments are automatically billed when they are due. example: true tax_certificate: $ref: '#/components/schemas/taxCertificate' tax_identifier: $ref: '#/components/schemas/taxIdentifier' currency: type: string description: >- Three-letter ISO currency code. Once the currency is set for an account, it cannot be updated. example: USD sales_rep: type: string description: The name of the sales representative associated with this account example: Max accountCreateRequest: type: object title: AccountCreateRequest description: '' additionalProperties: false properties: id: type: string readOnly: true description: Unique identifier for the object. updated_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who last updated the object updated_time: type: string format: date-time readOnly: true description: >- The date and time when the object was last updated in ISO 8601 UTC format. created_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who created the object created_time: type: string format: date-time readOnly: true description: >- The date and time when the object was created in ISO 8601 UTC format. custom_fields: $ref: '#/components/schemas/customFields' custom_objects: oneOf: - $ref: '#/components/schemas/listCustomObjectResponse' - $ref: '#/components/schemas/custom_object' readOnly: true description: The custom objects associated with a Zuora standard object. account_number: type: string description: Human-readable identifier of the account. It can be user-supplied. example: A-100001 billing_document_settings: $ref: '#/components/schemas/billingDocumentSettings' batch: type: string description: The identifier of a bill run batch. bill_cycle_day: type: integer minimum: 0 maximum: 31 description: >- The day of the month on which your customer will be invoiced. For month-end specify 31. bill_to: allOf: - $ref: '#/components/schemas/accountContactCreateRequest' description: Customer billing address. sold_to: allOf: - $ref: '#/components/schemas/accountContactCreateRequest' description: Customer address used for calculating tax. communication_profile_id: type: string description: >- Identifier of the communication profile associated with this customer. example: 2c92c0946a6dffc0016a7faab604299b crm_id: type: string description: CRM account identifier. example: 1a2b3c4d5e default_payment_method_id: type: string description: Identifier of the default payment method on the customer account. example: 8a95b1946b6aeac8718c32aab8c395f name: type: string description: The name of the customer account. example: test account description: type: string description: >- An arbitrary string attached to the object. Often useful for displaying to users. example: description of test account parent_account_id: type: string description: Identifier of this customer's parent account, if any. example: 8ad093f27d6eee80017d6effd7a66759 payment_gateway: type: string description: Payment gateway name. example: adyen gateway payment_terms: type: string description: >- Payment terms configured in **Billing Settings > Payment Terms** of your Zuora tenant. example: Net 30 sequence_set_id: type: string description: >- The identifier or the billing document sequence set that is assigned to the customer account. example: 2c92a4204a6dffc0016a7faab723041c auto_pay: type: boolean description: >- Controls whether future payments are automatically billed when they are due. example: true tax_certificate: $ref: '#/components/schemas/taxCertificate' tax_identifier: $ref: '#/components/schemas/taxIdentifier' currency: type: string description: >- Three-letter ISO currency code. Once the currency is set for an account, it cannot be updated. example: USD sales_rep: type: string description: The name of the sales representative associated with this account example: Max payment_method: x-displayName: Get an Account allOf: - $ref: '#/components/schemas/accountPaymentMethodRequest' description: A new payment method for the account. required: - currency - bill_to - name orderLineItemRevenue: type: object title: OrderLineItemRevenue description: Accounting configuration if you have Zuora Revenue enabled. additionalProperties: false properties: exclude_item_billing_from_revenue_accounting: type: boolean description: >- If set to `true`, any associated billing document items are excluded from the revenue accounting. exclude_item_booking_from_revenue_accounting: type: boolean description: >- If set to `true`, any associated subscription items are excluded from the revenue accounting. adjustment_revenue_account: type: string description: An active accounting code in your Zuora chart of accounts. contract_recognized_revenue_account: type: string description: An active accounting code in your Zuora chart of accounts. deferred_revenue_account: type: string maxLength: 100 description: An active accounting code in your Zuora chart of accounts. recognized_revenue_account: type: string maxLength: 100 description: An active accounting code in your Zuora chart of accounts. revenue_recognition_rule_name: type: string description: The revenue recognition rule for the order line item. lineItem: type: object title: LineItem description: Data of order line items. additionalProperties: false properties: id: type: string readOnly: true description: Unique identifier for the object. updated_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who last updated the object updated_time: type: string format: date-time readOnly: true description: >- The date and time when the object was last updated in ISO 8601 UTC format. created_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who created the object created_time: type: string format: date-time readOnly: true description: >- The date and time when the object was created in ISO 8601 UTC format. custom_fields: $ref: '#/components/schemas/customFields' custom_objects: oneOf: - $ref: '#/components/schemas/listCustomObjectResponse' - $ref: '#/components/schemas/custom_object' readOnly: true description: The custom objects associated with a Zuora standard object. unit_of_measure: type: string description: >- A configured unit of measure. This field is required for per-unit prices. unit_amount: type: number description: >- The unit amount of the price. Specify this field if you want to override the original price with a per-unit price. target_date: type: string format: date description: >- The target date for the order line item to be picked up by bill run for billing. deferred_revenue_account: type: string maxLength: 100 description: An active accounting code in your Zuora chart of accounts. description: type: string description: >- An arbitrary string attached to the object. Often useful for displaying to users. revenue: allOf: - $ref: '#/components/schemas/revenue' discount_unit_amount: type: number description: >- Discount amount. Specify this field if you offer an amount-based discount. discount_percent: type: number description: >- Discount percent. Specify this field if you offer a percentage-based discount. category: type: string enum: - sale - return description: >- The category for the order line item, to indicate a product sale or return. state: type: string enum: - pending - booked - sent_to_billing - complete - canceled description: >- The state of an order line item. If you want to generate billing documents for order line items, you must set this field to `sent_to_billing`. For invoice preview, you do not need to set this field. type: type: string description: The type of the order line item. name: type: string description: Name of the order line item item_number: type: string description: >- Human-readable identifier of the order item. It can be user-supplied. list_unit_price: type: number description: The list price per unit for the order line item. product_code: type: string description: The product code for the order line item. price_id: type: string description: Identifier of the price. purchase_order_number: type: string description: >- Used by customers to specify the Purchase Order Number provided by the buyer. quantity: type: number description: >- The quantity of units, such as the number of authors in a hosted wiki service. recognized_revenue_account: type: string maxLength: 100 description: An active accounting code in your Zuora chart of accounts. revenue_recognition_rule_name: type: string description: The revenue recognition rule for the order line item. sold_to_id: type: string description: Customer address used for calculating tax. example: 8ad0823f8040e52d0180433026b156fe tax_code: type: string description: >- A tax code identifier. If a `tax_code` of a price is not provided when you create or update a price, Zuora will treat the charged amount as non-taxable. If this code is provide, Zuora considers that this price is taxable and the charged amount will be handled accordingly. tax_inclusive: type: boolean description: >- If this field is set to `true`, it indicates that amounts are inclusive of tax. start_date: type: string format: date description: >- The date a transaction starts. The default value of this field is the order date. example: '2022-01-01' end_date: type: string format: date description: >- The date a transaction is completed. The default value of this field is the transaction start date. Also, the value of this field should always equal or be later than the value of the `start_date` field. example: '2022-01-01' invoice_items: allOf: - $ref: '#/components/schemas/invoiceItemListResponse' readOnly: true description: List of invoice items. EXPANDABLE related_subscription_number: type: string description: >- Use this field to relate an order line item to an subscription. Specify this field to the subscription number of the subscription to relate. billing_rule: type: string enum: - trigger_without_fulfillment - trigger_on_fulfillment description: The billing rule for the Order Line Item. total: type: string description: The total amount, including the total tax amount. subtotal: type: string description: 'The total amount exclusive of tax. ' original_order_date: type: string format: date description: >- The date when the subscription item is created through an order. This field is to standardize the booking date information to increase audit ability and traceability of data between Zuora Billing and Zuora Revenue. It is mapped as the booking date for a sales order line in Zuora Revenue. example: '2022-01-01' accounting_code: type: string description: The accounting code for the order line item. adjustment_liability_account: type: string description: >- The accounting code on the Order Line Item object for customers using Zuora Billing - Revenue Integration. adjustment_revenue_account: type: string description: >- The accounting code on the Order Line Item object for customers using Zuora Billing - Revenue Integration. discount_total: type: string description: The total discount amount. list_price: type: string description: >- The extended list price for an order line item, calculated by the formula: listPrice = listPricePerUnit * quantity original_sold_to_id: type: string description: >- The ID of a contact that belongs to the billing account of the order line item. Use this field to assign an existing account as the sold-to contact of an order line item. unbilled_receivables_account: type: string description: >- The accounting code on the Order Line Item object for customers using Zuora Billing - Revenue Integration. orderLineItem: type: object title: OrderLineItem description: Data of order line items. additionalProperties: false properties: id: type: string readOnly: true description: Unique identifier for the object. updated_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who last updated the object updated_time: type: string format: date-time readOnly: true description: >- The date and time when the object was last updated in ISO 8601 UTC format. created_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who created the object created_time: type: string format: date-time readOnly: true description: >- The date and time when the object was created in ISO 8601 UTC format. custom_fields: type: object title: CustomFields description: >- Set of user-defined fields associated with this object. Useful for storing additional information about the object in a structured format. x-extra-field-annotation: '@JsonAdapter(CustomFieldAdapter.class)' additionalProperties: true custom_objects: oneOf: - $ref: '#/components/schemas/listCustomObjectResponse' - $ref: '#/components/schemas/custom_object' readOnly: true description: The custom objects associated with a Zuora standard object. revenue: type: object title: OrderLineItemRevenue description: Accounting configuration if you have Zuora Revenue enabled. additionalProperties: false properties: exclude_item_billing_from_revenue_accounting: type: boolean description: >- If set to `true`, any associated billing document items are excluded from the revenue accounting. exclude_item_booking_from_revenue_accounting: type: boolean description: >- If set to `true`, any associated subscription items are excluded from the revenue accounting. adjustment_revenue_account: type: string description: An active accounting code in your Zuora chart of accounts. contract_recognized_revenue_account: type: string description: An active accounting code in your Zuora chart of accounts. deferred_revenue_account: type: string maxLength: 100 description: An active accounting code in your Zuora chart of accounts. recognized_revenue_account: type: string maxLength: 100 description: An active accounting code in your Zuora chart of accounts. revenue_recognition_rule_name: type: string description: The revenue recognition rule for the order line item. unit_of_measure: type: string description: A configured unit of measure. accounting_code: type: string description: An active accounting code in your Zuora chart of accounts. adjustment_liability_account: type: string description: An active accounting code in your Zuora chart of accounts. unit_amount: type: number description: The unit amount to be charged. target_date: type: string format: date description: >- All order line items that were unbilled on or before this date are included in future bill runs. billing_rule: enum: - trigger_without_fulfillment - trigger_on_fulfillment description: The billing rule for the order line item. contract_asset_account: type: string description: An active accounting code in your Zuora chart of accounts. contract_liability_account: type: string description: An active accounting code in your Zuora chart of accounts. description: type: string description: >- An arbitrary string attached to the object. Often useful for displaying to users. discount_unit_amount: type: number description: Discount amount per unit. discount_percent: type: number description: Discount percent. category: enum: - sale - return description: >- The category for the order line item, to indicate a product sale or return. name: type: string description: The name of the order line item. type: enum: - product - fee - services description: The type of the order line item. list_unit_price: type: number description: The list price per unit for the order line item. product_code: type: string description: The product code for the order line item. purchase_order_number: type: string description: >- Used by customers to specify the Purchase Order Number provided by the buyer. quantity: type: number description: The quantity of the product ordered. related_subscription_number: type: string description: Use this field to relate an order line item to an subscription. sold_to_id: type: string description: >- The unique identifier of a contact belonging to the billing account of the order line item. Use this field to assign and existing contact as the sold to contact of an order line item. example: 8ad0823f8040e52d0180433026b156fe tax_code: type: string description: The tax code for the order line item. unbilled_receivables_account: type: string description: An active accounting code in your Zuora chart of accounts.. state: enum: - pending - booked - sent_to_billing - complete - canceled description: >- The state of an order line item. If you want to generate billing documents for order line items, you must set this field to `sent_to_billing`. For invoice preview, you do not need to set this field. item_number: type: string description: >- Human-readable identifier of the order item. It can be user-supplied. start_date: type: string format: date description: >- The date a transaction starts. The default value of this field is the order date. example: '2022-01-01' end_date: type: string format: date description: The date the order line item transitions to complete. example: '2022-01-01' price_id: type: string description: Identifier of the price. quantity_available_for_return: type: number description: The quantity of the product ordered available for return. tax_inclusive: type: boolean description: >- If this field is set to `true`, it indicates that amounts are inclusive of tax. invoice_items: allOf: - $ref: '#/components/schemas/invoiceItemListResponse' readOnly: true description: List of invoice items. EXPANDABLE order_id: type: string description: >- The unique identifier for the order associated with this order line item. total: type: number description: Total after discounts and taxes. subtotal: type: number description: Total before discounts and taxes are applied. quantity_fulfilled: type: number description: The quantity fulfilled. quantity_pending_fulfillment: type: number description: The quantity pending fulfillment. requires_fulfillment: type: boolean description: If true, a fulfillment is required to trigger billing. original_order_date: type: string format: date description: >- The date when the subscription item is created through an order. This field is to standardize the booking date information to increase audit ability and traceability of data between Zuora Billing and Zuora Revenue. It is mapped as the booking date for a sales order line in Zuora Revenue. example: '2022-01-01' original_order_id: type: string description: >- The unique identifier of the original sales order for a return order line item. original_order_line_item_id: type: string description: >- The unique identifier of the original sales order line item for a return order line item. original_order_line_item_number: type: string description: >- The number of the original sales order line item for a return order line item. original_order_number: type: string description: The number of the original sales order for a return order line item. discount_total: type: number description: Total discount amount. list_price: type: number description: >- The extended list price for an order line item, calculated by the formula: listPrice = listPricePerUnit * quantity original_sold_to_id: type: string description: >- The unique identifier of a contact belonging to the billing account of the order line item that was the original sold to contact when the order line item was created. lineItemCreateRequest: type: object title: LineItemCreateRequest description: Order line items additionalProperties: false properties: unit_of_measure: type: string description: >- A configured unit of measure. This field is required for per-unit prices. unit_amount: type: number description: >- The unit amount of the price. Specify this field if you want to override the original price with a per-unit price. target_date: type: string format: date description: >- The target date for the order line item to be picked up by bill run for billing. custom_fields: $ref: '#/components/schemas/customFields' deferred_revenue_account: type: string maxLength: 100 description: An active accounting code in your Zuora chart of accounts. description: type: string description: >- An arbitrary string attached to the object. Often useful for displaying to users. revenue: allOf: - $ref: '#/components/schemas/revenue' discount_unit_amount: type: number description: >- Discount amount. Specify this field if you offer an amount-based discount. discount_percent: type: number description: >- Discount percent. Specify this field if you offer a percentage-based discount. category: type: string enum: - sale - return description: >- The category for the order line item, to indicate a product sale or return. state: type: string enum: - pending - booked - sent_to_billing - complete - canceled description: >- The state of an order line item. If you want to generate billing documents for order line items, you must set this field to `sent_to_billing`. For invoice preview, you do not need to set this field. type: type: string enum: - product - fee - services description: The type of the order line item. name: type: string description: The name of the order line item. item_number: type: string description: >- Human-readable identifier of the order item. It can be user-supplied. list_unit_price: type: number description: The list price per unit for the order line item. product_code: type: string description: The product code for the order line item. price_id: type: string description: Identifier of the price. purchase_order_number: type: string description: >- Used by customers to specify the Purchase Order Number provided by the buyer. quantity: type: number description: >- The quantity of units, such as the number of authors in a hosted wiki service. recognized_revenue_account: type: string maxLength: 100 description: An active accounting code in your Zuora chart of accounts. revenue_recognition_rule_name: type: string description: The revenue recognition rule for the order line item. sold_to_id: type: string description: Customer address used for calculating tax. example: 8ad0823f8040e52d0180433026b156fe tax_code: type: string description: >- A tax code identifier. If a `tax_code` of a price is not provided when you create or update a price, Zuora will treat the charged amount as non-taxable. If this code is provide, Zuora considers that this price is taxable and the charged amount will be handled accordingly. tax_inclusive: type: boolean description: >- If this field is set to `true`, it indicates that amounts are inclusive of tax. start_date: type: string format: date description: >- The date a transaction starts. The default value of this field is the order date. example: '2022-01-01' end_date: type: string format: date description: >- The date a transaction is completed. The default value of this field is the transaction start date. Also, the value of this field should always equal or be later than the value of the `start_date` field. example: '2022-01-01' invoice_items: allOf: - $ref: '#/components/schemas/invoiceItemListResponse' readOnly: true description: List of invoice items. EXPANDABLE related_subscription_number: type: string description: >- Relates an order line item to a subscription when you create the order line item. billing_rule: type: string enum: - trigger_without_fulfillment - trigger_on_fulfillment description: The billing rule for the Order Line Item. required: - name - type lineItemListResponse: type: object title: LineItemListResponse description: '' nullable: false additionalProperties: false properties: next_page: type: string nullable: true data: type: array items: $ref: '#/components/schemas/orderLineItem' lineItemPatchRequest: type: object title: LineItemPatchRequest description: Update an order line item additionalProperties: false properties: revenue: $ref: '#/components/schemas/orderLineItemRevenue' unit_of_measure: type: string description: A configured unit of measure. accounting_code: type: string description: An active accounting code in your Zuora chart of accounts. adjustment_liability_account: type: string description: An active accounting code in your Zuora chart of accounts. unit_amount: type: number description: The unit amount to be charged. target_date: type: string format: date description: >- All order line items that were unbilled on or before this date are included in future bill runs. billing_rule: enum: - trigger_without_fulfillment - trigger_on_fulfillment description: The billing rule for the order line item. contract_asset_account: type: string description: An active accounting code in your Zuora chart of accounts. contract_liability_account: type: string description: An active accounting code in your Zuora chart of accounts. custom_fields: $ref: '#/components/schemas/customFields' description: type: string description: >- An arbitrary string attached to the object. Often useful for displaying to users. discount_unit_amount: type: number description: Discount amount per unit. discount_percent: type: number description: Discount percent. category: enum: - sale - return description: Category of the order line item. name: type: string description: The name of the order line item. type: enum: - product - fee - services description: The type of the order line item. list_unit_price: type: number description: The list price per unit for the order line item. product_code: type: string description: The product code for the order line item. purchase_order_number: type: string description: >- Used by customers to specify the Purchase Order Number provided by the buyer. quantity: type: number description: The quantity of the product ordered. related_subscription_number: type: string description: Use this field to relate an order line item to an subscription. sold_to_id: type: string description: >- The unique identifier of a contact belonging to the billing account of the order line item. Use this field to assign and existing contact as the sold to contact of an order line item. example: 8ad0823f8040e52d0180433026b156fe tax_code: type: string description: The tax code for the order line item. unbilled_receivables_account: type: string description: An active accounting code in your Zuora chart of accounts.. state: enum: - pending - booked - sent_to_billing - complete - canceled description: >- The state of an order line item. If you want to generate billing documents for order line items, you must set this field to `sent_to_billing`. For invoice preview, you do not need to set this field. item_number: type: string description: >- Human-readable identifier of the order item. It can be user-supplied. start_date: type: string format: date description: >- The date a transaction starts. The default value of this field is the order date. example: '2022-01-01' end_date: type: string format: date description: The date the order line item transitions to complete. example: '2022-01-01' orderCancellationRequest: type: object title: OrderCancellationRequest description: '' nullable: false additionalProperties: false properties: cancel_reason: type: string description: The reason for cancelling the order. ordersProcessingOption: type: object title: OrdersProcessingOption description: Processing options for the invoice or payment. additionalProperties: false properties: document_date: type: string format: date description: The date printed on billing documents. target_date: type: string format: date description: >- The target date for the order to be picked up by bill run for billing. collection_method: type: string enum: - collect_payment - create_invoice - process_refund - run_billing description: >- Specifies whether to just create an invoice, or to create an invoice and collect payment. payment_method_id: type: string description: Payment method Id used to pay billing documents. payment_gateway_id: type: string description: >- Identifier of the payment gateway Zuora will use to authorize the payments that are made with this payment method. example: 8ad093d07ae636bb017ae97518762aa3 draft_invoice: type: boolean refund_reason_code: type: string orderListResponse: type: object title: OrderListResponse description: '' nullable: false additionalProperties: false properties: next_page: type: string nullable: true data: type: array items: $ref: '#/components/schemas/order' orderCreateRequest: type: object title: OrderCreateRequest description: '' nullable: false additionalProperties: false properties: category: type: string enum: - sale - return description: >- Category of the order to indicate a product sale or return. Default value is `sale`. custom_objects: oneOf: - $ref: '#/components/schemas/listCustomObjectResponse' - $ref: '#/components/schemas/custom_object' readOnly: true description: The custom objects associated with a Zuora standard object. custom_fields: $ref: '#/components/schemas/customFields' description: type: string description: >- An arbitrary string attached to the object. Often useful for displaying to users. example: description of test account account_number: type: string description: Human-readable identifier of the account. It can be user-supplied. example: A-100001 account_id: type: string description: Identifier of the account. example: 2c92c0f86a8dd422016a9e7a70116b0d account_data: allOf: - $ref: '#/components/schemas/accountCreateRequest' description: >- The information of the new account that owns the subscription. The subscription owner account can be different from the invoice owner account. If you specify this field, do not specify `account_id`. order_date: type: string format: date description: >- The date when the order is signed. All the order actions under this order will use this order date as the contract effective date if the contract effective date field is skipped or its value is left as null. example: '2022-01-01' order_number: type: string description: >- The order number of the new order. If not provided, system will auto-generate a number for this order. Note: Ensure that the order number does not contain a slash. line_items: type: array items: $ref: '#/components/schemas/lineItemCreateRequest' description: >- Order line items are non-subscription-based items created by an order, representing transactional charges such as one-time fees, physical goods, or professional service charges that are not sold as subscription services. By specifying this field, you can launch non-subscription and unified monetization business models in Zuora, in addition to subscription business models. processing_options: $ref: '#/components/schemas/ordersProcessingOption' subscriptions: type: array items: $ref: '#/components/schemas/postSubscriptionOrderRequest' description: >- Based on the intended order action, each item should include specific fields. For example, to create a new subscription for a new account, you must specify the `account_data` and `subscription_plans` fields at a minimum. state: type: string enum: - pending - complete - draft - canceled - scheduled - executing - failed description: The status of the order. order: type: object title: Order description: '' nullable: false additionalProperties: false properties: id: type: string readOnly: true description: Unique identifier for the object. updated_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who last updated the object updated_time: type: string format: date-time readOnly: true description: >- The date and time when the object was last updated in ISO 8601 UTC format. created_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who created the object created_time: type: string format: date-time readOnly: true description: >- The date and time when the object was created in ISO 8601 UTC format. custom_fields: type: object title: CustomFields description: >- Set of user-defined fields associated with this object. Useful for storing additional information about the object in a structured format. x-extra-field-annotation: '@JsonAdapter(CustomFieldAdapter.class)' additionalProperties: true custom_objects: oneOf: - $ref: '#/components/schemas/listCustomObjectResponse' - $ref: '#/components/schemas/custom_object' readOnly: true description: The custom objects associated with a Zuora standard object. order_number: type: string description: >- The order number of the new order. If not provided, system will auto-generate a number for this order. Note: Ensure that the order number does not contain a slash. order_date: type: string format: date description: >- The date when the order is signed. All the order actions under this order will use this order date as the contract effective date if the contract effective date field is skipped or its value is left as null. example: '2022-01-01' description: type: string description: >- An arbitrary string attached to the object. Often useful for displaying to users. example: description of test account category: type: string enum: - sale - return description: >- Category of the order to indicate a product sale or return. Default value is `sale`. account_id: type: string description: Identifier of the account associated with this subscription. account: allOf: - $ref: '#/components/schemas/account' description: Information of the new account associated with the subscription. line_items: type: object title: LineItemListResponse description: '' nullable: false additionalProperties: false properties: next_page: type: string nullable: true data: type: array items: $ref: '#/components/schemas/orderLineItem' subscriptions: type: array items: $ref: '#/components/schemas/postSubscriptionOrderResponse' description: >- Each item includes specific fields based on the intended order action. state: type: string enum: - pending - complete - draft - canceled - scheduled - executing - failed description: The status of the order. subscriptionVersionOrder: type: object title: SubscriptionVersionOrder description: '' nullable: false additionalProperties: false properties: id: type: string readOnly: true description: Unique identifier for the object. updated_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who last updated the object updated_time: type: string format: date-time readOnly: true description: >- The date and time when the object was last updated in ISO 8601 UTC format. created_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who created the object created_time: type: string format: date-time readOnly: true description: >- The date and time when the object was created in ISO 8601 UTC format. custom_fields: $ref: '#/components/schemas/customFields' custom_objects: oneOf: - $ref: '#/components/schemas/listCustomObjectResponse' - $ref: '#/components/schemas/custom_object' readOnly: true description: The custom objects associated with a Zuora standard object. order_number: type: string description: >- The order number of the new order. If not provided, system will auto-generate a number for this order. Note: Ensure that the order number does not contain a slash. order_date: type: string format: date description: >- The date when the order is signed. All the order actions under this order will use this order date as the contract effective date if the contract effective date field is skipped or its value is left as null. example: '2022-01-01' description: type: string description: >- An arbitrary string attached to the object. Often useful for displaying to users. example: description of test account category: type: string enum: - sale - return description: >- Category of the order to indicate a product sale or return. Default value is `sale`. line_items: $ref: '#/components/schemas/lineItemListResponse' state: type: string enum: - pending - complete - draft - canceled - scheduled - executing - failed description: The status of the order. actions: allOf: - $ref: '#/components/schemas/orderActionListResponse' refundOrderTransactions: type: object title: RefundOrderTransactions description: '' nullable: false additionalProperties: false properties: number: type: string description: The number of the refund. invoice_numbers: type: array items: type: string description: The numbers of the related invoices. state: allOf: - type: object properties: succeeded: type: string readOnly: true failed: type: string readOnly: true description: The states of the refunds. refunds: allOf: - $ref: '#/components/schemas/refund' description: The related invoices. arTransactionsOrders: type: object title: ArTransactionsOrders description: '' nullable: false additionalProperties: false properties: credit_memo_numbers: type: array items: type: string description: The numbers of related credit memos. credit_memos: allOf: - $ref: '#/components/schemas/creditMemo' description: The related credit memos. invoice_numbers: type: array items: type: string description: The numbers of related invoices invoices: allOf: - $ref: '#/components/schemas/invoice' description: The related invoices. refunds: type: array items: $ref: '#/components/schemas/refundOrderTransactions' description: The related refunds. payments: type: array items: $ref: '#/components/schemas/paymentTransactions' description: The related payments. orderCancelResponse: type: object title: OrderCancelResponse description: '' nullable: false additionalProperties: false properties: id: type: string readOnly: true description: Unique identifier for the object. updated_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who last updated the object updated_time: type: string format: date-time readOnly: true description: >- The date and time when the object was last updated in ISO 8601 UTC format. created_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who created the object created_time: type: string format: date-time readOnly: true description: >- The date and time when the object was created in ISO 8601 UTC format. custom_fields: type: object title: CustomFields description: >- Set of user-defined fields associated with this object. Useful for storing additional information about the object in a structured format. x-extra-field-annotation: '@JsonAdapter(CustomFieldAdapter.class)' additionalProperties: true custom_objects: oneOf: - $ref: '#/components/schemas/listCustomObjectResponse' - $ref: '#/components/schemas/custom_object' readOnly: true description: The custom objects associated with a Zuora standard object. order_number: type: string description: >- The order number of the new order. If not provided, system will auto-generate a number for this order. Note: Ensure that the order number does not contain a slash. order_date: type: string format: date description: >- The date when the order is signed. All the order actions under this order will use this order date as the contract effective date if the contract effective date field is skipped or its value is left as null. example: '2022-01-01' description: type: string description: >- An arbitrary string attached to the object. Often useful for displaying to users. example: description of test account category: type: string enum: - sale - return description: >- Category of the order to indicate a product sale or return. Default value is `sale`. account_id: type: string description: Identifier of the account associated with this subscription. account: allOf: - $ref: '#/components/schemas/account' description: Information of the new account associated with the subscription. line_items: type: object title: LineItemListResponse description: '' nullable: false additionalProperties: false properties: next_page: type: string nullable: true data: type: array items: $ref: '#/components/schemas/orderLineItem' subscriptions: type: array items: $ref: '#/components/schemas/postSubscriptionOrderResponse' description: >- Each item includes specific fields based on the intended order action. state: type: string enum: - pending - complete - draft - canceled - scheduled - executing - failed description: The status of the order. ar_transactions: allOf: - $ref: '#/components/schemas/arTransactionsOrders' write_offs: type: array items: $ref: '#/components/schemas/writeOff' description: The billing documents that are written off. lineItemsPreviewResponse: type: object title: LineItemsPreviewResponse description: '' nullable: false additionalProperties: false properties: mrr: type: object properties: gross_amount: type: number net_amount: type: number currency: type: string tcb: type: object properties: gross_amount: type: number net_amount: type: number currency: type: string tcv: type: object properties: gross_amount: type: number net_amount: type: number currency: type: string orderPreviewCreateRequest: type: object title: OrderPreviewCreateRequest description: '' nullable: false additionalProperties: false properties: category: type: string enum: - sale - return description: >- Category of the order to indicate a product sale or return. Default value is `sale`. custom_fields: $ref: '#/components/schemas/customFields' description: type: string description: >- An arbitrary string attached to the object. Often useful for displaying to users. example: description of test account account_number: type: string description: Human-readable identifier of the account. It can be user-supplied. example: A-100001 account_id: type: string description: Identifier of the account. example: 2c92c0f86a8dd422016a9e7a70116b0d order_date: type: string format: date description: >- The date when the order is signed. All the order actions under this order will use this order date as the contract effective date if the contract effective date field is skipped or its value is left as null. example: '2022-01-01' order_number: type: string description: >- The order number of the new order. If not provided, system will auto-generate a number for this order. Note: Ensure that the order number does not contain a slash. line_items: type: array items: $ref: '#/components/schemas/lineItemCreateRequest' description: >- Order line items are non-subscription-based items created by an order, representing transactional charges such as one-time fees, physical goods, or professional service charges that are not sold as subscription services. By specifying this field, you can launch non-subscription and unified monetization business models in Zuora, in addition to subscription business models. subscriptions: type: array items: $ref: '#/components/schemas/postSubscriptionOrderRequest' description: >- Based on the intended order action, each item should include specific fields. For example, to preview a new subscription for a new account, you must specify the `account_data` and `subscription_plans` fields at a minimum. account_data: $ref: '#/components/schemas/subscriptionPreviewAccountRequest' number_of_periods: type: integer description: Specifies how many billing periods you want to preview. term_end: type: boolean description: >- Indicates whether to preview the subscription till the end of the current term. metrics: type: array items: type: string enum: - billing_documents - delta_metrics description: >- Specifies the metrics you want to preview. You can preview metrics of billing documents, the order delta metrics, or both. end_date: type: string format: date description: >- End date of the period for which you want to preview the subscription required: - metrics tier: type: object title: Tier description: Tier information for tiered prices. additionalProperties: false properties: up_to: type: number description: >- The upper bound of a tier. The lower bound of a tier is the upper bound of the previous tier plus one or some fraction of one, depending on the precision of the unit of measure. amounts: allOf: - $ref: '#/components/schemas/money' description: >- Prices for the tier. Only set if `charge_model` is `tiered`, `tiered_overage`, or `highwatermark_tiered`. unit_amounts: allOf: - $ref: '#/components/schemas/money' description: >- Per unit prices for units in the tier. Only set if `charge_model` is `tiered`, `tiered_overage`, or `highwatermark_tiered`. itemTier: type: object title: ItemTier description: Tiers information of the billing document items. additionalProperties: false properties: up_to: type: number description: >- Specifies the upper bound of the tier. The lower bound of a tier is the upper bound of the previous tier plus one. amount: type: number description: >- The amount of the price. Specify this field if you want to override the original price with a flat-fee price. unit_amount: type: number description: >- The unit amount of the price. Specify this field if you want to override the original price with a per-unit price. overage: type: object title: Overage description: An object defining how overage charges are calculated. additionalProperties: false properties: interval_count: type: integer description: >- Specifies the number of intervals used to calculate smoothed overage charges. type: type: string enum: - rolling_window - rollover description: 'Represents the overage type: one of rolling_window or rollover.' included_units: type: number description: Specifies the included units to which overage charges do not apply. credit_unused_units: type: boolean description: Specifies whether or not to credit unused units. apply_at_end_of_smoothing_period: type: boolean description: >- Indicates if the overage price is calculated at the end of the smoothing period. revenue: type: object title: Revenue description: Accounting configuration if you have Zuora Revenue enabled. additionalProperties: false properties: exclude_item_billing_from_revenue_accounting: type: boolean description: >- If set to `true`, any associated billing document items are excluded from the revenue accounting. exclude_item_booking_from_revenue_accounting: type: boolean description: >- If set to `true`, any associated subscription items are excluded from the revenue accounting. recurring: type: object title: Recurring description: The recurring components of a price such as interval and usage. additionalProperties: false properties: recurring_on: type: string enum: - _1 - _2 - _3 - _4 - _5 - _6 - _7 - _8 - _9 - _10 - _11 - _12 - _13 - _14 - _15 - _16 - _17 - _18 - _19 - _20 - _21 - _22 - _23 - _24 - _25 - _26 - _27 - _28 - _29 - _30 - _31 - subscription_item_start_day - account_cycle_date - subscription_start_day - term_end_day - monday - tuesday - wednesday - thursday - friday - saturday - sunday description: >- Specifies on which day or the month or day of the week a customer shall be billed. 'on': type: string enum: - _1 - _2 - _3 - _4 - _5 - _6 - _7 - _8 - _9 - _10 - _11 - _12 - _13 - _14 - _15 - _16 - _17 - _18 - _19 - _20 - _21 - _22 - _23 - _24 - _25 - _26 - _27 - _28 - _29 - _30 - _31 - subscription_item_start_day - account_cycle_date - subscription_start_day - term_end_day - monday - tuesday - wednesday - thursday - friday - saturday - sunday deprecated: true x-replaced-by: recurring_on description: >- Specifies on which day or the month or day of the week a customer shall be billed. usage: type: boolean description: Indicates that this is a usage price. interval: type: string enum: - month - year - week - term - day description: Specifies the billing frequency. One of `week`, `month` or `year`. interval_count: type: integer description: >- The number of intervals (specified in the interval attribute) between subscription billings. For example, interval=month and intervalCount=3 bills every 3 months. alignment_behavior: type: string enum: - subscription_start - term_start - term_end - none description: >- Specifies how to align billing for recurring (subscription) products that start on different days. timing: type: string enum: - in_advance - in_arrears description: >- You can choose to bill in_advance or in_arrears for recurring prices. The field is not used with one-time or usage-based prices. formula: type: string readOnly: true description: >- You can choose to bill in_advance or in_arrears for recurring prices. The field is not used with one-time or usage-based prices. duration_interval: type: string enum: - day - week - month - year - subscription_term - billing_period description: Specifies the duration frequency. One of day, week, month or year. duration_interval_count: type: integer description: >- Specifies how long a customer shall be charged if this is less than the duration of the subscription rating_group: type: string enum: - billing_period - usage_start_date - usage_record - usage_upload - custom_group description: >- A rating group based on which usage records are rated. Only applicable to usage prices. prepayment: type: object title: Prepayment description: '' nullable: false additionalProperties: false properties: credit_option: type: string enum: - time_based - consumption_based - full_credit description: >- The way to calculate credit. See Credit Option for more information. quantity: type: number description: The number of units included in a prepayment charge. total_quantity: type: number description: >- The total amount of units that end customers can use during a validity period when they subscribe to a prepayment charge. unit_of_measure: type: string description: >- A configured unit of measure. This field is required for per-unit prices. validity_period: type: string enum: - subscription_term - annual - semi_annual - quarter - month description: >- The period in which the prepayment units are valid to use as defined in a prepayment charge. drawdown: type: object title: Drawdown description: '' nullable: false additionalProperties: false properties: conversion_rate: type: number description: >- The conversion rate between usage unit of measure (UOM) and drawdown unit of measure for a drawdown charge. **Note**: The `conversion_rate` and `unit_of_measure` fields need to have values or be empty at the same time. unit_of_measure: type: string description: Unit of measurement for a drawdown charge. price: type: object title: Price description: Price information. additionalProperties: false properties: id: type: string readOnly: true description: Unique identifier for the object. updated_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who last updated the object updated_time: type: string format: date-time readOnly: true description: >- The date and time when the object was last updated in ISO 8601 UTC format. created_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who created the object created_time: type: string format: date-time readOnly: true description: >- The date and time when the object was created in ISO 8601 UTC format. custom_fields: type: object title: CustomFields description: >- Set of user-defined fields associated with this object. Useful for storing additional information about the object in a structured format. x-extra-field-annotation: '@JsonAdapter(CustomFieldAdapter.class)' additionalProperties: true custom_objects: oneOf: - $ref: '#/components/schemas/listCustomObjectResponse' - $ref: '#/components/schemas/custom_object' readOnly: true description: The custom objects associated with a Zuora standard object. name: type: string description: The name of the price. description: type: string description: >- An arbitrary string attached to the object. Often useful for displaying to users. recognized_revenue_accounting_code: type: string maxLength: 100 deprecated: true description: An active accounting code in your Zuora chart of accounts. deferred_revenue_accounting_code: type: string maxLength: 100 deprecated: true description: An active accounting code in your Zuora chart of accounts. recurring: type: object title: Recurring description: The recurring components of a price such as interval and usage. additionalProperties: false properties: recurring_on: type: string enum: - _1 - _2 - _3 - _4 - _5 - _6 - _7 - _8 - _9 - _10 - _11 - _12 - _13 - _14 - _15 - _16 - _17 - _18 - _19 - _20 - _21 - _22 - _23 - _24 - _25 - _26 - _27 - _28 - _29 - _30 - _31 - subscription_item_start_day - account_cycle_date - subscription_start_day - term_end_day - monday - tuesday - wednesday - thursday - friday - saturday - sunday description: >- Specifies on which day or the month or day of the week a customer shall be billed. 'on': type: string enum: - _1 - _2 - _3 - _4 - _5 - _6 - _7 - _8 - _9 - _10 - _11 - _12 - _13 - _14 - _15 - _16 - _17 - _18 - _19 - _20 - _21 - _22 - _23 - _24 - _25 - _26 - _27 - _28 - _29 - _30 - _31 - subscription_item_start_day - account_cycle_date - subscription_start_day - term_end_day - monday - tuesday - wednesday - thursday - friday - saturday - sunday deprecated: true x-replaced-by: recurring_on description: >- Specifies on which day or the month or day of the week a customer shall be billed. usage: type: boolean description: Indicates that this is a usage price. interval: type: string enum: - month - year - week - term - day description: >- Specifies the billing frequency. One of `week`, `month` or `year`. interval_count: type: integer description: >- The number of intervals (specified in the interval attribute) between subscription billings. For example, interval=month and intervalCount=3 bills every 3 months. alignment_behavior: type: string enum: - subscription_start - term_start - term_end - none description: >- Specifies how to align billing for recurring (subscription) products that start on different days. timing: type: string enum: - in_advance - in_arrears description: >- You can choose to bill in_advance or in_arrears for recurring prices. The field is not used with one-time or usage-based prices. formula: type: string readOnly: true description: >- You can choose to bill in_advance or in_arrears for recurring prices. The field is not used with one-time or usage-based prices. duration_interval: type: string enum: - day - week - month - year - subscription_term - billing_period description: >- Specifies the duration frequency. One of day, week, month or year. duration_interval_count: type: integer description: >- Specifies how long a customer shall be charged if this is less than the duration of the subscription rating_group: type: string enum: - billing_period - usage_start_date - usage_record - usage_upload - custom_group description: >- A rating group based on which usage records are rated. Only applicable to usage prices. start_event: type: string enum: - contract_effective - service_activation - customer_acceptance - specific_date description: Specifies when to start billing your customer. tiers_mode: type: string enum: - graduated - volume - high_watermark_volume - high_watermark_graduated - graduated_with_overage deprecated: true description: Specifies the mode for tiered prices. apply_discount_to: type: array items: type: string enum: - one_time - recurring - usage description: Any combination of one_time, recurring and plan. tiers: type: array items: $ref: '#/components/schemas/tier' description: >- Price information for different tiers. When creating or updating tiered prices, you must specify this field and the `tiers_mode` field. tax_code: type: string description: >- A tax code identifier. If a `tax_code` of a price is not provided when you create or update a price, Zuora will treat the charged amount as non-taxable. If this code is provide, Zuora considers that this price is taxable and the charged amount will be handled accordingly. tax_inclusive: type: boolean description: >- If this field is set to `true`, it indicates that amounts are inclusive of tax. unit_of_measure: type: string description: >- A configured unit of measure. This field is required for per-unit prices. quantity: type: number description: Quantity of the product to which your customers subscribe. min_quantity: type: number description: >- The minimum quantity for a price. Specify this field and the `max_quantity` field to create a range of quantities allowed in a price. max_quantity: type: number description: >- The maximum quantity for a price. Specify this field and the `min_quantity` field to create a range of quantities allowed in a price. discount_level: type: string enum: - account - subscription - plan description: >- Specifies at what level a discount should be applied: account, subscription, or plan. revenue_recognition_rule: type: string enum: - on_invoice - daily_over_time description: >- Determines when to recognize the revenue for this charge. You can choose to recognize upon invoicing or daily over time. stacked_discount: type: boolean description: >- This field is only applicable for the Percentage Discount price. This field indicates whether the discount is to be calculated as stacked discount. Possible values are as follows: For more information, see Stacked discounts amounts: type: object additionalProperties: type: number example: USD: 10 GBP: 15 unit_amounts: type: object additionalProperties: type: number example: USD: 10 GBP: 15 discount_amounts: type: object additionalProperties: type: number example: USD: 10 GBP: 15 discount_percent: type: number description: >- Discount percent. Specify this field if you offer a percentage-based discount. price_base_interval: type: string enum: - month - billing_period - week description: >- Specifies the base interval of a price. If not provided, this field defaults to `billing_period`. overage: allOf: - $ref: '#/components/schemas/overage' deprecated: true revenue: allOf: - $ref: '#/components/schemas/revenue' accounting_code: type: string description: >- An active accounting code defined in **Finance Settings > Configure Accounting Codes** in your Zuora tenant. prepayment: type: object title: Prepayment description: '' nullable: false additionalProperties: false properties: credit_option: type: string enum: - time_based - consumption_based - full_credit description: >- The way to calculate credit. See Credit Option for more information. quantity: type: number description: The number of units included in a prepayment charge. total_quantity: type: number description: >- The total amount of units that end customers can use during a validity period when they subscribe to a prepayment charge. unit_of_measure: type: string description: >- A configured unit of measure. This field is required for per-unit prices. validity_period: type: string enum: - subscription_term - annual - semi_annual - quarter - month description: >- The period in which the prepayment units are valid to use as defined in a prepayment charge. drawdown: type: object title: Drawdown description: '' nullable: false additionalProperties: false properties: conversion_rate: type: number description: >- The conversion rate between usage unit of measure (UOM) and drawdown unit of measure for a drawdown charge. **Note**: The `conversion_rate` and `unit_of_measure` fields need to have values or be empty at the same time. unit_of_measure: type: string description: Unit of measurement for a drawdown charge. taxable: type: boolean plan_id: type: string description: Specify the ID of a plan to which this price is associated. plan_number: type: string description: >- Specify the number of a plan to which this price is associated. This field is required if plan_id is not supplied custom_field_per_unit_rate: type: string writeOnly: true description: >- Name of the custom field that will be used to set a per unit rate under the `Pre-Rated Per Unit` charge model custom_field_total_amount: type: string writeOnly: true description: >- Name of the custom field that will be used to set a total amount under the `Pre-Rated` charge model product_id: type: string description: Identifier of the product. active: type: boolean deprecated: true description: Whether the price can be used for new purchases. charge_type: type: string description: The type of charge. Can be `one_time`,`recurring`, or `usage`. charge_model: type: string description: >- The charge model of the price, which determines how users are charged. Common charge models include flat fee, per-unit, volume, and tiered prices. priceListResponse: type: object title: PriceListResponse description: '' nullable: false additionalProperties: false properties: next_page: type: string nullable: true data: type: array items: $ref: '#/components/schemas/price' pricePatchRequest: type: object title: PricePatchRequest description: '' nullable: false additionalProperties: false properties: id: type: string readOnly: true description: Unique identifier for the object. updated_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who last updated the object updated_time: type: string format: date-time readOnly: true description: >- The date and time when the object was last updated in ISO 8601 UTC format. created_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who created the object created_time: type: string format: date-time readOnly: true description: >- The date and time when the object was created in ISO 8601 UTC format. custom_fields: $ref: '#/components/schemas/customFields' custom_objects: oneOf: - $ref: '#/components/schemas/listCustomObjectResponse' - $ref: '#/components/schemas/custom_object' readOnly: true description: The custom objects associated with a Zuora standard object. name: type: string description: The name of the price. description: type: string description: >- An arbitrary string attached to the object. Often useful for displaying to users. recognized_revenue_accounting_code: type: string maxLength: 100 deprecated: true description: An active accounting code in your Zuora chart of accounts. deferred_revenue_accounting_code: type: string maxLength: 100 deprecated: true description: An active accounting code in your Zuora chart of accounts. recurring: $ref: '#/components/schemas/recurring' start_event: type: string enum: - contract_effective - service_activation - customer_acceptance - specific_date description: Specifies when to start billing your customer. tiers_mode: type: string enum: - graduated - volume - high_watermark_volume - high_watermark_graduated - graduated_with_overage deprecated: true description: Specifies the mode for tiered prices. apply_discount_to: type: array items: type: string enum: - one_time - recurring - usage description: Any combination of one_time, recurring and plan. tiers: type: array items: $ref: '#/components/schemas/tier' description: >- Price information for different tiers. When creating or updating tiered prices, you must specify this field and the `tiers_mode` field. tax_code: type: string description: >- A tax code identifier. If a `tax_code` of a price is not provided when you create or update a price, Zuora will treat the charged amount as non-taxable. If this code is provide, Zuora considers that this price is taxable and the charged amount will be handled accordingly. tax_inclusive: type: boolean description: >- If this field is set to `true`, it indicates that amounts are inclusive of tax. unit_of_measure: type: string description: >- A configured unit of measure. This field is required for per-unit prices. quantity: type: number description: Quantity of the product to which your customers subscribe. min_quantity: type: number description: >- The minimum quantity for a price. Specify this field and the `max_quantity` field to create a range of quantities allowed in a price. max_quantity: type: number description: >- The maximum quantity for a price. Specify this field and the `min_quantity` field to create a range of quantities allowed in a price. discount_level: type: string enum: - account - subscription - plan description: >- Specifies at what level a discount should be applied: account, subscription, or plan. revenue_recognition_rule: type: string enum: - on_invoice - daily_over_time description: >- Determines when to recognize the revenue for this charge. You can choose to recognize upon invoicing or daily over time. stacked_discount: type: boolean description: >- This field is only applicable for the Percentage Discount price. This field indicates whether the discount is to be calculated as stacked discount. Possible values are as follows: For more information, see Stacked discounts amounts: $ref: '#/components/schemas/money' unit_amounts: $ref: '#/components/schemas/money' discount_amounts: $ref: '#/components/schemas/money' discount_percent: type: number description: >- Discount percent. Specify this field if you offer a percentage-based discount. price_base_interval: type: string enum: - month - billing_period - week description: >- Specifies the base interval of a price. If not provided, this field defaults to `billing_period`. overage: allOf: - $ref: '#/components/schemas/overage' deprecated: true revenue: allOf: - $ref: '#/components/schemas/revenue' accounting_code: type: string description: >- An active accounting code defined in **Finance Settings > Configure Accounting Codes** in your Zuora tenant. prepayment: $ref: '#/components/schemas/prepayment' drawdown: $ref: '#/components/schemas/drawdown' taxable: type: boolean product: type: object title: Product description: Product information. additionalProperties: false properties: id: type: string readOnly: true description: Unique identifier for the object. updated_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who last updated the object updated_time: type: string format: date-time readOnly: true description: >- The date and time when the object was last updated in ISO 8601 UTC format. created_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who created the object created_time: type: string format: date-time readOnly: true description: >- The date and time when the object was created in ISO 8601 UTC format. custom_fields: type: object title: CustomFields description: >- Set of user-defined fields associated with this object. Useful for storing additional information about the object in a structured format. x-extra-field-annotation: '@JsonAdapter(CustomFieldAdapter.class)' additionalProperties: true custom_objects: oneOf: - $ref: '#/components/schemas/listCustomObjectResponse' - $ref: '#/components/schemas/custom_object' readOnly: true description: The custom objects associated with a Zuora standard object. start_date: type: string format: date description: The date from which the product can be used for new purchases. end_date: type: string format: date description: >- The date on which the product can no longer be used for new purchases. name: type: string description: The name of the product. type: type: string enum: - base - add_on - other description: The type of product. sku: type: string description: The sku identifier of the product. description: type: string description: >- An arbitrary string attached to the object. Often useful for displaying to users. active: type: boolean description: Whether the product can be used for new purchases. plans: allOf: - $ref: '#/components/schemas/planListResponse' readOnly: true description: A list of plans. productListResponse: type: object title: ProductListResponse description: '' nullable: false additionalProperties: false properties: next_page: type: string nullable: true data: type: array items: $ref: '#/components/schemas/product' priceCreateRequest: type: object title: PriceCreateRequest description: '' additionalProperties: false properties: id: type: string readOnly: true description: Unique identifier for the object. updated_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who last updated the object updated_time: type: string format: date-time readOnly: true description: >- The date and time when the object was last updated in ISO 8601 UTC format. created_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who created the object created_time: type: string format: date-time readOnly: true description: >- The date and time when the object was created in ISO 8601 UTC format. custom_fields: $ref: '#/components/schemas/customFields' custom_objects: oneOf: - $ref: '#/components/schemas/listCustomObjectResponse' - $ref: '#/components/schemas/custom_object' readOnly: true description: The custom objects associated with a Zuora standard object. name: type: string description: The name of the price. description: type: string description: >- An arbitrary string attached to the object. Often useful for displaying to users. recognized_revenue_accounting_code: type: string maxLength: 100 deprecated: true description: An active accounting code in your Zuora chart of accounts. deferred_revenue_accounting_code: type: string maxLength: 100 deprecated: true description: An active accounting code in your Zuora chart of accounts. recurring: $ref: '#/components/schemas/recurring' start_event: type: string enum: - contract_effective - service_activation - customer_acceptance - specific_date default: contract_effective description: Specifies when to start billing your customer. tiers_mode: type: string enum: - graduated - volume - high_watermark_volume - high_watermark_graduated - graduated_with_overage deprecated: true description: Specifies the mode for tiered prices. apply_discount_to: type: array items: type: string enum: - one_time - recurring - usage description: Any combination of one_time, recurring and plan. tiers: type: array items: $ref: '#/components/schemas/tier' description: >- Price information for different tiers. When creating or updating tiered prices, you must specify this field and the `tiers_mode` field. tax_code: type: string description: >- A tax code identifier. If a `tax_code` of a price is not provided when you create or update a price, Zuora will treat the charged amount as non-taxable. If this code is provide, Zuora considers that this price is taxable and the charged amount will be handled accordingly. tax_inclusive: type: boolean description: >- If this field is set to `true`, it indicates that amounts are inclusive of tax. unit_of_measure: type: string description: >- A configured unit of measure. This field is required for per-unit prices. quantity: type: number description: Quantity of the product to which your customers subscribe. min_quantity: type: number description: >- The minimum quantity for a price. Specify this field and the `max_quantity` field to create a range of quantities allowed in a price. max_quantity: type: number description: >- The maximum quantity for a price. Specify this field and the `min_quantity` field to create a range of quantities allowed in a price. discount_level: type: string enum: - account - subscription - plan description: >- Specifies at what level a discount should be applied: account, subscription, or plan. revenue_recognition_rule: type: string enum: - on_invoice - daily_over_time description: >- Determines when to recognize the revenue for this charge. You can choose to recognize upon invoicing or daily over time. stacked_discount: type: boolean description: >- This field is only applicable for the Percentage Discount price. This field indicates whether the discount is to be calculated as stacked discount. Possible values are as follows: For more information, see Stacked discounts amounts: $ref: '#/components/schemas/money' unit_amounts: $ref: '#/components/schemas/money' discount_amounts: $ref: '#/components/schemas/money' discount_percent: type: number description: >- Discount percent. Specify this field if you offer a percentage-based discount. price_base_interval: type: string enum: - month - billing_period - week default: billing_period description: >- Specifies the base interval of a price. If not provided, this field defaults to `billing_period`. overage: allOf: - $ref: '#/components/schemas/overage' deprecated: true revenue: allOf: - $ref: '#/components/schemas/revenue' accounting_code: type: string description: >- An active accounting code defined in **Finance Settings > Configure Accounting Codes** in your Zuora tenant. prepayment: $ref: '#/components/schemas/prepayment' drawdown: $ref: '#/components/schemas/drawdown' taxable: type: boolean plan_id: type: string description: Specify the ID of a plan to which this price is associated. plan_number: type: string description: >- Specify the number of a plan to which this price is associated. This field is required if plan_id is not supplied custom_field_per_unit_rate: type: string writeOnly: true description: >- Name of the custom field that will be used to set a per unit rate under the `Pre-Rated Per Unit` charge model custom_field_total_amount: type: string writeOnly: true description: >- Name of the custom field that will be used to set a total amount under the `Pre-Rated` charge model required: - name planPatchRequest: type: object title: PlanPatchRequest description: '' nullable: false additionalProperties: false properties: id: type: string readOnly: true description: Unique identifier for the object. updated_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who last updated the object updated_time: type: string format: date-time readOnly: true description: >- The date and time when the object was last updated in ISO 8601 UTC format. created_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who created the object created_time: type: string format: date-time readOnly: true description: >- The date and time when the object was created in ISO 8601 UTC format. custom_fields: $ref: '#/components/schemas/customFields' custom_objects: oneOf: - $ref: '#/components/schemas/listCustomObjectResponse' - $ref: '#/components/schemas/custom_object' readOnly: true description: The custom objects associated with a Zuora standard object. start_date: type: string format: date description: The date from which the plan can be used for new purchases. end_date: type: string format: date description: The date on which the plan can no longer be used for new purchases. name: type: string description: The name of the plan. plan_number: type: string description: Human-readable identifier of the plan. It can be user-supplied. description: type: string description: >- An arbitrary string attached to the object. Often useful for displaying to users. active_currencies: type: array items: type: string description: >- A list of 3-letter ISO-standard currency codes representing active currencies for the plan. plan: type: object title: Plan description: Plan information. additionalProperties: false properties: id: type: string readOnly: true description: Unique identifier for the object. updated_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who last updated the object updated_time: type: string format: date-time readOnly: true description: >- The date and time when the object was last updated in ISO 8601 UTC format. created_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who created the object created_time: type: string format: date-time readOnly: true description: >- The date and time when the object was created in ISO 8601 UTC format. custom_fields: type: object title: CustomFields description: >- Set of user-defined fields associated with this object. Useful for storing additional information about the object in a structured format. x-extra-field-annotation: '@JsonAdapter(CustomFieldAdapter.class)' additionalProperties: true custom_objects: oneOf: - $ref: '#/components/schemas/listCustomObjectResponse' - $ref: '#/components/schemas/custom_object' readOnly: true description: The custom objects associated with a Zuora standard object. start_date: type: string format: date description: The date from which the plan can be used for new purchases. end_date: type: string format: date description: The date on which the plan can no longer be used for new purchases. name: type: string description: The name of the plan. plan_number: type: string description: Human-readable identifier of the plan. It can be user-supplied. description: type: string description: >- An arbitrary string attached to the object. Often useful for displaying to users. active_currencies: type: array items: type: string description: >- A list of 3-letter ISO-standard currency codes representing active currencies for the plan. product_id: type: string description: Identifier of the product associated with this plan. active: type: boolean description: Whether the plan can be used for new purchases. product: allOf: - $ref: '#/components/schemas/product' description: The product associated with this plan. sku: type: string description: >- The product sku. This field is only availble for customers using high speed cache. prices: allOf: - $ref: '#/components/schemas/priceListResponse' readOnly: true description: A list of prices. planListResponse: type: object title: PlanListResponse description: '' nullable: false additionalProperties: false properties: next_page: type: string nullable: true data: type: array items: $ref: '#/components/schemas/plan' planCreateRequest: type: object title: PlanCreateRequest description: '' additionalProperties: false properties: id: type: string readOnly: true description: Unique identifier for the object. updated_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who last updated the object updated_time: type: string format: date-time readOnly: true description: >- The date and time when the object was last updated in ISO 8601 UTC format. created_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who created the object created_time: type: string format: date-time readOnly: true description: >- The date and time when the object was created in ISO 8601 UTC format. custom_fields: $ref: '#/components/schemas/customFields' custom_objects: oneOf: - $ref: '#/components/schemas/listCustomObjectResponse' - $ref: '#/components/schemas/custom_object' readOnly: true description: The custom objects associated with a Zuora standard object. start_date: type: string format: date description: The date from which the plan can be used for new purchases. end_date: type: string format: date description: The date on which the plan can no longer be used for new purchases. name: type: string description: The name of the plan. plan_number: type: string description: Human-readable identifier of the plan. It can be user-supplied. description: type: string description: >- An arbitrary string attached to the object. Often useful for displaying to users. active_currencies: type: array items: type: string description: >- A list of 3-letter ISO-standard currency codes representing active currencies for the plan. product_id: type: string description: Identifier of the product associated with this plan. required: - product_id - name productPatchRequest: type: object title: ProductPatchRequest description: '' nullable: false additionalProperties: false properties: id: type: string readOnly: true description: Unique identifier for the object. updated_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who last updated the object updated_time: type: string format: date-time readOnly: true description: >- The date and time when the object was last updated in ISO 8601 UTC format. created_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who created the object created_time: type: string format: date-time readOnly: true description: >- The date and time when the object was created in ISO 8601 UTC format. custom_fields: $ref: '#/components/schemas/customFields' custom_objects: oneOf: - $ref: '#/components/schemas/listCustomObjectResponse' - $ref: '#/components/schemas/custom_object' readOnly: true description: The custom objects associated with a Zuora standard object. start_date: type: string format: date description: The date from which the product can be used for new purchases. end_date: type: string format: date description: >- The date on which the product can no longer be used for new purchases. name: type: string description: The name of the product. type: type: string enum: - base - add_on - other description: The type of product. sku: type: string description: The sku identifier of the product. description: type: string description: >- An arbitrary string attached to the object. Often useful for displaying to users. productCreateRequest: type: object title: ProductCreateRequest description: '' additionalProperties: false properties: id: type: string readOnly: true description: Unique identifier for the object. updated_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who last updated the object updated_time: type: string format: date-time readOnly: true description: >- The date and time when the object was last updated in ISO 8601 UTC format. created_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who created the object created_time: type: string format: date-time readOnly: true description: >- The date and time when the object was created in ISO 8601 UTC format. custom_fields: $ref: '#/components/schemas/customFields' custom_objects: oneOf: - $ref: '#/components/schemas/listCustomObjectResponse' - $ref: '#/components/schemas/custom_object' readOnly: true description: The custom objects associated with a Zuora standard object. start_date: type: string format: date description: The date from which the product can be used for new purchases. end_date: type: string format: date description: >- The date on which the product can no longer be used for new purchases. name: type: string description: The name of the product. type: type: string enum: - base - add_on - other description: The type of product. sku: type: string description: The sku identifier of the product. description: type: string description: >- An arbitrary string attached to the object. Often useful for displaying to users. required: - name billingDocument: type: object title: BillingDocument description: '' nullable: false additionalProperties: false properties: id: type: string readOnly: true description: Unique identifier for the object. updated_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who last updated the object updated_time: type: string format: date-time readOnly: true description: >- The date and time when the object was last updated in ISO 8601 UTC format. created_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who created the object created_time: type: string format: date-time readOnly: true description: >- The date and time when the object was created in ISO 8601 UTC format. custom_fields: type: object title: CustomFields description: >- Set of user-defined fields associated with this object. Useful for storing additional information about the object in a structured format. x-extra-field-annotation: '@JsonAdapter(CustomFieldAdapter.class)' additionalProperties: true custom_objects: oneOf: - $ref: '#/components/schemas/listCustomObjectResponse' - $ref: '#/components/schemas/custom_object' readOnly: true description: The custom objects associated with a Zuora standard object. account_id: type: string description: Identifier of the account that owns the billing document. account_number: type: string description: >- Human-readable identifier of the account that owns the billing document. description: type: string description: >- An arbitrary string associated with the object. Often useful for displaying to users. due_date: type: string format: date description: The date on which payment for the billing document is due. example: '2023-01-01' document_date: type: string format: date description: The date when the billing document takes effect. example: '2023-01-01' reason_code: type: string description: >- Reason for issuing this billing document. This field is applicable only if the `type` field is set to `credit_memo` or `debit_memo`. invoice_id: type: string description: >- The identifier of the invoice billing document from which this credit memo or debit memo billing document is created. This field is applicable only if the `type` field is set to `credit_memo` or `debit_memo`. transfer_to_accounting: type: boolean description: Whether to transfer to an external accounting system. exclude_from_auto_apply_rules: type: boolean description: >- Indicates whether to exclude this credit memo billing document from the rule of automatically applying it to invoices. This field is applicable only if the `type` field is set to `credit_memo`. pay: type: boolean description: >- Indicates whether the billing document is automatically picked up for processing in the corresponding payment run. type: type: string enum: - credit_memo - debit_memo - invoice description: >- The type of billing document. Can be one of the credit memo, debit memo, or invoice. billing_document_number: type: string readOnly: true description: >- A human-readable identifier for the billing document; may be user-supplied. amount_refunded: type: number description: The amount of this billing document item refunded. state_transitions: allOf: - type: object properties: posted_time: type: string readOnly: true canceled_time: type: string readOnly: true posted_by_id: type: string readOnly: true description: Identifier of the Zuora user who posted the billing document. state: type: string enum: - draft - open - uncollectible - failed description: The status of the billing document. account: allOf: - $ref: '#/components/schemas/account' description: The account that owns the billing document. EXPANDABLE items: allOf: - $ref: '#/components/schemas/billingDocumentItemListResponse' readOnly: true description: List of billing document items. total: type: number readOnly: true description: The total amount. subtotal: type: number readOnly: true description: The total amount exclusive of tax. tax: type: number readOnly: true description: The total tax amount. balance: type: number readOnly: true deprecated: true description: >- The total balance remaining. This field is deprecated. Use `remaining_balance` field. remaining_balance: type: number readOnly: true description: The total balance remaining. amount_paid: type: number readOnly: true description: The total amount paid. paid: type: boolean readOnly: true description: >- Whether payment was successfully collected for this invoice. An invoice can be paid with a payment or a credit memo. past_due: type: boolean readOnly: true description: Whether payment is past due. billingDocumentListResponse: type: object title: BillingDocumentListResponse description: '' nullable: false additionalProperties: false properties: next_page: type: string nullable: true data: type: array items: $ref: '#/components/schemas/billingDocument' billingDocumentCreateRequest: type: object title: BillingDocumentCreateRequest description: '' additionalProperties: false properties: account_id: type: string description: Identifier of the account that owns the billing document. account_number: type: string description: >- Human-readable identifier of the account that owns the billing document. description: type: string description: >- An arbitrary string associated with the object. Often useful for displaying to users. due_date: type: string format: date description: The date on which payment for the billing document is due. example: '2022-01-01' document_date: type: string format: date description: The date when the billing document takes effect. example: '2023-01-01' reason_code: type: string description: >- Reason for issuing this billing document. This field is applicable only if the `type` field is set to `credit_memo` or `debit_memo`. invoice_id: type: string description: >- The identifier of the invoice billing document from which this credit memo or debit memo billing document is created. This field is applicable only if the `type` field is set to `credit_memo` or `debit_memo`. transfer_to_accounting: type: boolean description: Whether to transfer to an external accounting system. custom_fields: $ref: '#/components/schemas/customFields' exclude_from_auto_apply_rules: type: boolean description: >- Indicates whether to exclude this credit memo billing document from the rule of automatically applying it to invoices. This field is applicable only if the `type` field is set to `credit_memo`. pay: type: boolean description: >- Indicates whether the billing document is automatically picked up for processing in the corresponding payment run. type: type: string enum: - credit_memo - debit_memo - invoice description: >- The type of billing document. Can be one of the credit memo, debit memo, or invoice. items: type: array items: $ref: '#/components/schemas/billingDocumentItemCreateRequest' description: Information of all billing document items. apply: type: boolean description: Whether to automatically apply the billing document upon posting. post: type: boolean description: >- Whether to automatically post a billing document after it is created. required: - type billingDocumentItemPaymentApplicationRequest: type: object title: BillingDocumentItemPaymentApplicationRequest description: '' nullable: false additionalProperties: false properties: id: type: string description: Identifier of an invoice item or a debit memo item. amount: type: number description: The amount applied to this billing document item or taxation item. taxation_item_id: type: string description: The identifier of a taxation item. required: - id - amount billingDocumentPaymentApplicationRequest: type: object title: BillingDocumentPaymentApplicationRequest description: '' additionalProperties: false properties: id: type: string description: >- Identifier of the billing document to which the credit memo, payment, or refund is applied. type: type: string enum: - debit_memo - invoice description: The type of billing document. amount: type: number description: The amount applied to this billing document. billing_document_number: type: string readOnly: true description: >- A human-readable identifier for the billing document; may be user-supplied. items: type: array items: $ref: '#/components/schemas/billingDocumentItemPaymentApplicationRequest' description: >- The billing document items (invoice items or debit memo items or taxation items) to which the payment is applied. required: - type - id - amount invoice: type: object title: Invoice description: '' nullable: false additionalProperties: false properties: id: type: string readOnly: true description: Unique identifier for the object. updated_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who last updated the object updated_time: type: string format: date-time readOnly: true description: >- The date and time when the object was last updated in ISO 8601 UTC format. created_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who created the object created_time: type: string format: date-time readOnly: true description: >- The date and time when the object was created in ISO 8601 UTC format. custom_fields: type: object title: CustomFields description: >- Set of user-defined fields associated with this object. Useful for storing additional information about the object in a structured format. x-extra-field-annotation: '@JsonAdapter(CustomFieldAdapter.class)' additionalProperties: true custom_objects: oneOf: - $ref: '#/components/schemas/listCustomObjectResponse' - $ref: '#/components/schemas/custom_object' readOnly: true description: The custom objects associated with a Zuora standard object. account_id: type: string description: Identifier of the account that owns the invoice. account_number: type: string description: Human-readable identifier of the account that owns the invoice. description: type: string description: >- An arbitrary string associated with the object. Often useful for displaying to users. due_date: type: string format: date description: The date on which payment for the invoice is due. example: '2023-01-01' document_date: type: string format: date description: The date when the invoice takes effect. example: '2023-01-01' transfer_to_accounting: type: boolean description: Whether to transfer to an external accounting system. pay: type: boolean description: >- Indicates whether the invoice is automatically picked up for processing in the corresponding payment run. invoice_number: type: string readOnly: true description: A human-readable identifier for the invoice; may be user-supplied. state_transitions: allOf: - type: object properties: posted_time: type: string readOnly: true canceled_time: type: string readOnly: true posted_by_id: type: string readOnly: true description: Identifier of the Zuora user who posted the invoice. state: type: string enum: - draft - posted - canceled - failed description: The status of the invoice. account: allOf: - $ref: '#/components/schemas/account' description: The account that owns the invoice. EXPANDABLE items: allOf: - $ref: '#/components/schemas/invoiceItemListResponse' readOnly: true description: List of invoice items. total: type: number readOnly: true description: The total amount. subtotal: type: number readOnly: true description: The total amount exclusive of tax. tax: type: number readOnly: true description: The total tax amount. balance: type: number readOnly: true deprecated: true description: >- The total balance remaining. This field is deprecated. Use `remaining_balance` field. remaining_balance: type: number readOnly: true description: The total balance remaining. paid: type: boolean readOnly: true description: >- Whether payment was successfully collected for this invoice. An invoice can be paid with a payment or a credit memo. past_due: type: boolean readOnly: true description: Whether payment is past due. bill_to_id: type: string nullable: true x-extra-field-annotation: '@JsonAdapter(NullableFieldAdapter.class)' description: ID of the bill-to contact. example: 2c92c0f86a8dd422016a9e7a70116b0d payment_terms: type: string nullable: true x-extra-field-annotation: '@JsonAdapter(NullableFieldAdapter.class)' description: The name of payment term associated with the invoice. bill_to: allOf: - $ref: '#/components/schemas/contact' readOnly: true description: The billing address for the customer. billing_document_settings: allOf: - $ref: '#/components/schemas/flexibleBillingDocumentSettings' description: The billing document settings for the customer. sold_to_id: type: string nullable: true x-extra-field-annotation: '@JsonAdapter(NullableFieldAdapter.class)' description: ID of the sold-to contact. example: 2c92c0f86a8dd422016a9e7a70116b0d sold_to: allOf: - $ref: '#/components/schemas/contact' readOnly: true description: The selling address for the customer. flexibleBillingDocumentSettings: type: object title: FlexibleBillingDocumentSettings description: '' nullable: false additionalProperties: false properties: template_id: type: string nullable: true x-extra-field-annotation: '@JsonAdapter(NullableFieldAdapter.class)' description: >- Identifier of the invoice template associated with this customer. Not applicable for debit memos or credit memos. example: 2c92c08b6a8c978f016a9e0084622b62 sequence_set_id: type: string nullable: true x-extra-field-annotation: '@JsonAdapter(NullableFieldAdapter.class)' description: ID of the billing document sequence set. invoiceListResponse: type: object title: InvoiceListResponse description: '' nullable: false additionalProperties: false properties: next_page: type: string nullable: true data: type: array items: $ref: '#/components/schemas/invoice' invoiceCreateRequest: type: object title: InvoiceCreateRequest description: '' nullable: false additionalProperties: false properties: account_id: type: string description: Identifier of the account that owns the invoice. account_number: type: string description: Human-readable identifier of the account that owns the invoice. description: type: string description: >- An arbitrary string associated with the object. Often useful for displaying to users. due_date: type: string format: date description: The date on which payment for the invoice is due. example: '2022-01-01' document_date: type: string format: date description: The date when the invoice takes effect. example: '2023-01-01' transfer_to_accounting: type: boolean description: Whether to transfer to an external accounting system. custom_fields: $ref: '#/components/schemas/customFields' pay: type: boolean description: >- Indicates whether the invoice is automatically picked up for processing in the corresponding payment run. items: type: array items: $ref: '#/components/schemas/invoiceItemCreateRequest' description: Information of all invoice items. post: type: boolean description: Whether to automatically post an invoice after it is created. invoiceEmailRequest: type: object title: InvoiceEmailRequest description: '' nullable: false additionalProperties: false properties: email: type: string description: >- An arbitrary list of comma-separated email addresses. Note: this parameter will be ignored if use_email_template is true. use_email_template: type: boolean description: >- Indicates whether to email an invoice based on your email template settings. If you set this field to true, the invoice is sent to the email addresses specified in the To Email field of the email template. invoicePatchRequest: type: object title: InvoicePatchRequest description: '' nullable: false additionalProperties: false properties: pay: type: boolean description: >- Indicates whether the billing document is automatically picked up for processing in the corresponding payment run. description: type: string description: >- An arbitrary string associated with the object. Often useful for displaying to users. due_date: type: string format: date description: The date on which payment for the billing document is due. example: '2022-01-01' document_date: type: string format: date description: The date when the billing document takes effect. example: '2023-01-01' custom_fields: $ref: '#/components/schemas/customFields' invoiceReverseRequest: type: object title: InvoiceReverseRequest description: '' nullable: false additionalProperties: false properties: document_date: type: string format: date description: The date that appears on the credit memo. example: '2023-01-01' apply_date: type: string format: date example: '2023-01-01' memoInvoiceItemCreateRequest: type: object title: MemoInvoiceItemCreateRequest description: '' additionalProperties: false properties: amount: type: number description: >- Amount (in the currency specified) of the invoice item. This should always be equal to unit_amount * quantity. description: type: string description: >- An arbitrary string associated with the object. Often useful for displaying to users. deferred_revenue_account: type: string description: An active account in your Zuora Chart of Accounts. on_account_account: type: string description: An active account in your Zuora Chart of Accounts. recognized_revenue_account: type: string description: An active account in your Zuora Chart of Accounts. revenue_recognition_rule_name: type: string description: >- The name of the revenue recognition rule governing the revenue schedule. quantity: type: number description: The number of units of this item. service_end: type: string format: date description: >- The end date of the service period associated with this invoice item. If the price for the associated subscription item is a one-time fee, then this date is the date of that subscription item. example: '2022-01-01' service_start: type: string format: date description: >- The start date of the service period associated with this invoice item. If the price for the associated subscription item is a one-time fee, then this date is the date of that subscription item. example: '2022-01-01' sku: type: string description: >- The unique SKU (stock keeping unit) of the product associated with this item. tax_inclusive: type: boolean description: >- Indicates whether the invoice item amount is inclusive or exclusive of tax. unit_of_measure: type: string description: Specifies the units used to measure usage. taxation_items: type: array items: $ref: '#/components/schemas/taxationItemCreateRequest' description: List of taxation items. unit_amount: type: number description: Unit amount (in the currency specified) of the invoice item. booking_reference: type: string description: The booking reference for this invoice item. price_id: type: string description: The identifier of the price this invoice item is associated with. purchase_order_number: type: string description: The purchase order number associated with this invoice item. tax_code: type: string description: The designated tax code. document_item_date: type: string format: date-time description: >- The date when the invoice item takes effect. This field is applicable only if the `type` field is set to `invoice`. example: '2022-01-01' name: type: string description: >- Name of the invoice item displayed to customers on billing documents. accounting_code: type: string custom_fields: $ref: '#/components/schemas/customFields' invoice_item_id: type: string description: The identifier of the invoice item associated with this memo item. required: - service_start - amount invoiceItemCreateRequest: type: object title: InvoiceItemCreateRequest description: '' additionalProperties: false properties: amount: type: number description: >- Amount (in the currency specified) of the invoice item. This should always be equal to unit_amount * quantity. description: type: string description: >- An arbitrary string associated with the object. Often useful for displaying to users. deferred_revenue_account: type: string description: An active account in your Zuora Chart of Accounts. on_account_account: type: string description: An active account in your Zuora Chart of Accounts. recognized_revenue_account: type: string description: An active account in your Zuora Chart of Accounts. revenue_recognition_rule_name: type: string description: >- The name of the revenue recognition rule governing the revenue schedule. quantity: type: number description: The number of units of this item. service_end: type: string format: date description: >- The end date of the service period associated with this invoice item. If the price for the associated subscription item is a one-time fee, then this date is the date of that subscription item. example: '2022-01-01' service_start: type: string format: date description: >- The start date of the service period associated with this invoice item. If the price for the associated subscription item is a one-time fee, then this date is the date of that subscription item. example: '2022-01-01' sku: type: string description: >- The unique SKU (stock keeping unit) of the product associated with this item. tax_inclusive: type: boolean description: >- Indicates whether the invoice item amount is inclusive or exclusive of tax. unit_of_measure: type: string description: Specifies the units used to measure usage. taxation_items: type: array items: $ref: '#/components/schemas/taxationItemCreateRequest' description: List of taxation items. unit_amount: type: number description: Unit amount (in the currency specified) of the invoice item. booking_reference: type: string description: The booking reference for this invoice item. price_id: type: string description: The identifier of the price this invoice item is associated with. purchase_order_number: type: string description: The purchase order number associated with this invoice item. tax_code: type: string description: The designated tax code. document_item_date: type: string format: date-time description: >- The date when the invoice item takes effect. This field is applicable only if the `type` field is set to `invoice`. example: '2022-01-01' name: type: string description: >- Name of the invoice item displayed to customers on billing documents. accounting_code: type: string custom_fields: $ref: '#/components/schemas/customFields' required: - service_start - amount payInvoiceRequest: type: object title: PayInvoiceRequest description: '' additionalProperties: false properties: amount: type: number description: The amount of the payment. account_id: type: string description: >- Identifier of the account that owns the invoice. Either `account_id` or `account_number` is required. account_number: type: string description: >- Human-readable identifier of the account that owns the invoice. Either `account_number` or `account_id` is required. authorization_id: type: string description: >- Identifier of the authorization transaction from the payment gateway. description: type: string description: >- An arbitrary string attached to the object. Often useful for displaying to users. currency: type: string description: 3-letter ISO 4217 currency code. bank_account_account: type: string description: An active account in your Zuora Chart of Accounts. payment_date: type: string format: date description: The date and time when the payment takes effect. payment_method_id: type: string description: Identifier of the payment method used to create this payment. gateway_id: type: string description: >- Identifier of the payment gateway that Zuora will use to authorize this payment. gateway_order_id: type: string description: >- A merchant-specified natural key value that can be passed to the payment gateway when a payment is created. If not specified, the payment number will be passed in instead. reference_id: type: string description: >- A second transaction identifier returned by the payment gateway if there is an additional transaction for the refunds. You may use this field to reconcile payments between your payment gateway and Zuora Payments. gateway_options: type: object additionalProperties: type: string example: key: value statement_descriptor: type: string description: A payment gateway-specific field used by Orbital, Vantiv and Verifi. statement_descriptor_phone: type: string description: A payment gateway-specific field used by Orbital, Vantiv and Verifi. external: type: boolean description: If true, indicates that this payment is not handled by Zuora. custom_fields: $ref: '#/components/schemas/customFields' required: - currency invoiceItem: type: object title: InvoiceItem description: '' nullable: false additionalProperties: false properties: id: type: string readOnly: true description: Unique identifier for the object. updated_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who last updated the object updated_time: type: string format: date-time readOnly: true description: >- The date and time when the object was last updated in ISO 8601 UTC format. created_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who created the object created_time: type: string format: date-time readOnly: true description: >- The date and time when the object was created in ISO 8601 UTC format. custom_fields: type: object title: CustomFields description: >- Set of user-defined fields associated with this object. Useful for storing additional information about the object in a structured format. x-extra-field-annotation: '@JsonAdapter(CustomFieldAdapter.class)' additionalProperties: true custom_objects: oneOf: - $ref: '#/components/schemas/listCustomObjectResponse' - $ref: '#/components/schemas/custom_object' readOnly: true description: The custom objects associated with a Zuora standard object. amount: type: number description: The total amount of this invoice item. description: type: string description: >- An arbitrary string associated with the object. Often useful for displaying to users. deferred_revenue_account: type: string description: >- The accounting code for the deferred revenue, such as Monthly Recurring Liability. recognized_revenue_account: type: string description: >- The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges. revenue_recognition_rule_name: type: string description: >- The name of the revenue recognition rule governing the revenue schedule. quantity: type: number description: The number of units of this item. service_end: type: string description: >- The end date of the service period associated with this invoice item. If the associated charge is a one-time fee, then this date is the date of that charge. accounts_receivable_account: type: string description: An active account in your Zuora Chart of Accounts. discount_item: type: boolean description: If true, indicates that the item is a discount item. applied_to_item_id: type: string description: >- Identifier of an invoice item or a debit memo item that this discount item or credit memo item is applied to. service_start: type: string description: >- The start date of the service period associated with this invoice item. If the associated charge is a one-time fee, then this date is the date of that charge. accounting_code: type: string invoice_id: type: string description: The identifier of the invoice associated with this invoice item. sku: type: string description: >- The unique SKU (stock keeping unit) of the product associated with this item. subscription_id: type: string description: The identifier of the subscription associated with the invoice item. tax_inclusive: type: boolean description: >- This specifies if the invoice item amount is inclusive or exclusive of tax. remaining_balance: type: number description: The remaining balance of this invoice item. unit_of_measure: type: string description: Specifies the units used to measure usage. unit_amount: type: number description: Unit amount (in the currency specified) of the invoice item. booking_reference: type: string description: The booking reference for this invoice item. name: type: string description: >- Name of the invoice item displayed to customers on billing documents. document_item_date: type: string format: date-time readOnly: true description: >- The date and time when the invoice item was created in ISO 8601 UTC format. price_id: type: string description: The identifier of the price this invoice item is associated with. purchase_order_number: type: string description: The purchase order number associated with this invoice item. tax: type: number description: The amount of tax applied to the invoice item. tax_code: type: string description: The designated tax code. subscription_item_id: type: string description: >- The identifier the subscription item associated with this invoice item. taxation_items: type: object title: TaxationItemListResponse description: Information of the taxation items. additionalProperties: false properties: next_page: type: string nullable: true data: type: array items: $ref: '#/components/schemas/taxationItem' invoice: allOf: - $ref: '#/components/schemas/invoice' description: The invoice the item belongs to. EXPANDABLE line_item: allOf: - $ref: '#/components/schemas/lineItem' description: The order line item associated with this invoice item. EXPANDABLE subscription: allOf: - $ref: '#/components/schemas/subscription' readOnly: true description: List of customer subscriptions. subscription_item: allOf: - $ref: '#/components/schemas/subscriptionItem' description: >- The expandable subscription item associated with this billing document item. invoiceItemListResponse: type: object title: InvoiceItemListResponse description: '' nullable: false additionalProperties: false properties: next_page: type: string nullable: true data: type: array items: $ref: '#/components/schemas/invoiceItem' writeOffItemsRequest: type: object title: WriteOffItemsRequest description: '' nullable: false additionalProperties: false properties: description: type: string description: >- An arbitrary string associated with the object. Often useful for displaying to users. deferred_revenue_account: type: string description: An active account in your Zuora Chart of Accounts. on_account_account: type: string description: An active account in your Zuora Chart of Accounts. recognized_revenue_account: type: string description: An active account in your Zuora Chart of Accounts. revenue_recognition_rule_name: type: string description: >- The name of the revenue recognition rule governing the revenue schedule. service_end: type: string format: date description: >- The end date of the service period associated with this invoice item. If the price for the associated subscription item is a one-time fee, then this date is the date of that subscription item. example: '2022-01-01' service_start: type: string format: date description: >- The start date of the service period associated with this invoice item. If the price for the associated subscription item is a one-time fee, then this date is the date of that subscription item. example: '2022-01-01' sku: type: string description: >- The unique SKU (stock keeping unit) of the product associated with this item. unit_of_measure: type: string description: Specifies the units used to measure usage. id: type: string description: The unique identifier of the invoice item. custom_fields: $ref: '#/components/schemas/customFields' writeOffRequest: type: object title: WriteOffRequest description: '' nullable: false additionalProperties: false properties: description: type: string description: >- An arbitrary string associated with the object. Often useful for displaying to users. document_date: type: string format: date description: The date when the invoice takes effect. example: '2023-01-01' reason_code: type: string description: Reason for issuing this credit memo custom_fields: $ref: '#/components/schemas/customFields' invoice_items: type: array items: $ref: '#/components/schemas/writeOffItemsRequest' description: Information of all invoice items. debitMemo: type: object title: DebitMemo description: '' nullable: false additionalProperties: false properties: id: type: string readOnly: true description: Unique identifier for the object. updated_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who last updated the object updated_time: type: string format: date-time readOnly: true description: >- The date and time when the object was last updated in ISO 8601 UTC format. created_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who created the object created_time: type: string format: date-time readOnly: true description: >- The date and time when the object was created in ISO 8601 UTC format. custom_fields: type: object title: CustomFields description: >- Set of user-defined fields associated with this object. Useful for storing additional information about the object in a structured format. x-extra-field-annotation: '@JsonAdapter(CustomFieldAdapter.class)' additionalProperties: true custom_objects: oneOf: - $ref: '#/components/schemas/listCustomObjectResponse' - $ref: '#/components/schemas/custom_object' readOnly: true description: The custom objects associated with a Zuora standard object. account_id: type: string description: Identifier of the account that owns the debit memo. account_number: type: string description: Human-readable identifier of the account that owns the debit memo. description: type: string description: >- An arbitrary string associated with the object. Often useful for displaying to users. due_date: type: string format: date description: The date on which payment for the billing document is due. example: '2023-01-01' document_date: type: string format: date description: The date when the debit memo takes effect. example: '2023-01-01' reason_code: type: string description: >- Reason for issuing this debit memo. This field is applicable only if the `type` field is set to `credit_memo` or `debit_memo`. invoice_id: type: string description: >- The identifier of the invoice from which this credit memo or debit memo is created. This field is applicable only if the `type` field is set to `credit_memo` or `debit_memo`. transfer_to_accounting: type: boolean description: Whether to transfer to an external accounting system. exclude_from_auto_apply_rules: type: boolean description: >- Indicates whether to exclude this credit memo from the rule of automatically applying it to invoices. This field is applicable only if the `type` field is set to `credit_memo`. pay: type: boolean description: >- Indicates whether this billing document is automatically picked up for processing in the corresponding payment run. debit_memo_number: type: string readOnly: true description: >- A human-readable identifier for the billing document; may be user-supplied. amount_refunded: type: number description: The amount of this billing document item refunded. state_transitions: allOf: - type: object properties: posted_time: type: string readOnly: true canceled_time: type: string readOnly: true posted_by_id: type: string readOnly: true description: Identifier of the Zuora user who posted the debit memo. state: type: string enum: - draft - posted - canceled - failed description: The status of the debit memo. account: allOf: - $ref: '#/components/schemas/account' description: The account that owns the billing document. EXPANDABLE items: allOf: - $ref: '#/components/schemas/billingDocumentItemListResponse' readOnly: true description: List of debit memo items. total: type: number readOnly: true description: The total amount. subtotal: type: number readOnly: true description: The total amount exclusive of tax. tax: type: number readOnly: true description: The total tax amount. balance: type: number readOnly: true deprecated: true description: >- The total balance remaining. This field is deprecated. Use `remaining_balance` field. remaining_balance: type: number readOnly: true description: The total balance remaining. amount_paid: type: number readOnly: true description: The total amount paid. paid: type: boolean readOnly: true description: >- Whether payment was successfully collected for this invoice. An invoice can be paid with a payment or a credit memo. past_due: type: boolean readOnly: true description: Whether payment is past due. bill_to_id: type: string nullable: true x-extra-field-annotation: '@JsonAdapter(NullableFieldAdapter.class)' description: ID of the bill-to contact. example: 2c92c0f86a8dd422016a9e7a70116b0d payment_terms: type: string nullable: true x-extra-field-annotation: '@JsonAdapter(NullableFieldAdapter.class)' description: The name of payment term associated with the invoice. bill_to: allOf: - $ref: '#/components/schemas/contact' readOnly: true description: The billing address for the customer. billing_document_settings: allOf: - $ref: '#/components/schemas/flexibleBillingDocumentSettings' description: The billing document settings for the customer. debitMemoListResponse: type: object title: DebitMemoListResponse description: '' nullable: false additionalProperties: false properties: next_page: type: string nullable: true data: type: array items: $ref: '#/components/schemas/debitMemo' debitMemoCreateRequest: type: object title: DebitMemoCreateRequest description: '' nullable: false additionalProperties: false properties: account_id: type: string description: Identifier of the account that owns the debit memo. account_number: type: string description: Human-readable identifier of the account that owns the debit memo. description: type: string description: >- An arbitrary string associated with the object. Often useful for displaying to users. due_date: type: string format: date description: The date on which payment for the debit memo is due. example: '2022-01-01' document_date: type: string format: date description: The date when the debit memo takes effect. example: '2023-01-01' reason_code: type: string description: >- Reason for issuing this debit memo. This field is applicable only if the `type` field is set to `credit_memo` or `debit_memo`. invoice_id: type: string description: >- The identifier of the invoice from which this credit memo or debit memo is created. This field is applicable only if the `type` field is set to `credit_memo` or `debit_memo`. transfer_to_accounting: type: boolean description: Whether to transfer to an external accounting system. custom_fields: $ref: '#/components/schemas/customFields' exclude_from_auto_apply_rules: type: boolean description: >- Indicates whether to exclude this credit memo from the rule of automatically applying it to invoices. This field is applicable only if the `type` field is set to `credit_memo`. pay: type: boolean description: >- Indicates whether this billing document is automatically picked up for processing in the corresponding payment run. items: type: array items: $ref: '#/components/schemas/billingDocumentItemCreateRequest' description: Information of all billing document items. apply: type: boolean description: Whether to automatically apply the billing document upon posting. post: type: boolean description: >- Whether to automatically post a billing document after it is created. debitMemoPatchRequest: type: object title: DebitMemoPatchRequest description: '' nullable: false additionalProperties: false properties: pay: type: boolean description: >- Indicates whether the billing document is automatically picked up for processing in the corresponding payment run. description: type: string description: >- An arbitrary string associated with the object. Often useful for displaying to users. due_date: type: string format: date description: The date on which payment for the billing document is due. example: '2022-01-01' document_date: type: string format: date description: The date when the billing document takes effect. example: '2023-01-01' reason_code: type: string description: >- Reason for issuing this billing document. This field is applicable only if the `type` field is set to `credit_memo` or `debit_memo`. custom_fields: $ref: '#/components/schemas/customFields' debitMemoItem: type: object title: DebitMemoItem description: '' nullable: false additionalProperties: false properties: id: type: string readOnly: true description: Unique identifier for the object. updated_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who last updated the object updated_time: type: string format: date-time readOnly: true description: >- The date and time when the object was last updated in ISO 8601 UTC format. created_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who created the object created_time: type: string format: date-time readOnly: true description: >- The date and time when the object was created in ISO 8601 UTC format. custom_fields: type: object title: CustomFields description: >- Set of user-defined fields associated with this object. Useful for storing additional information about the object in a structured format. x-extra-field-annotation: '@JsonAdapter(CustomFieldAdapter.class)' additionalProperties: true custom_objects: oneOf: - $ref: '#/components/schemas/listCustomObjectResponse' - $ref: '#/components/schemas/custom_object' readOnly: true description: The custom objects associated with a Zuora standard object. amount: type: number description: The total amount of this debit memo item. subtotal: type: number description: The total amount of this debit memo item exclusive of tax. description: type: string description: >- An arbitrary string associated with the object. Often useful for displaying to users. deferred_revenue_account: type: string description: >- The accounting code for the deferred revenue, such as Monthly Recurring Liability. on_account_account: type: string description: >- The accounting code that maps to an on account in your accounting system. recognized_revenue_account: type: string description: >- The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges. revenue_recognition_rule_name: type: string description: >- The name of the revenue recognition rule governing the revenue schedule. quantity: type: number description: The number of units of this item. service_end: type: string description: >- The end date of the service period associated with this debit memo item. If the associated charge is a one-time fee, then this date is the date of that charge. service_start: type: string description: >- The start date of the service period associated with this debit memo item. If the associated charge is a one-time fee, then this date is the date of that charge. accounts_receivable_account: type: string description: An active account in your Zuora Chart of Accounts. discount_item: type: boolean description: If true, indicates that the item is a discount item. applied_to_item_id: type: string description: >- Identifier of an invoice item that this debit memo item is applied to. accounting_code: type: string sku: type: string description: >- The unique SKU (stock keeping unit) of the product associated with this item. tax_inclusive: type: boolean description: >- This specifies if the debit memo item amount is inclusive or exclusive of tax. remaining_balance: type: number description: The remaining balance of this debit memo item. unit_of_measure: type: string description: Specifies the units used to measure usage. unit_amount: type: number description: Unit amount of the debit memo item. name: type: string description: >- Name of the billing document item displayed to customers on the billing document. price_id: type: string description: The identifier of the price this debit memo item is associated with. purchase_order_number: type: string description: The purchase order number associated with this debit memo item. tax: type: number description: The amount of tax applied to the debit memo item. tax_code: type: string description: The designated tax code. subscription_id: type: string description: >- The identifier of the subscription associated with the debit memo item. subscription_item_id: type: string description: >- The identifier the subscription item associated with this debit memo item. invoice_item_id: type: string description: >- The identifier of the invoice item associated with this debit memo item. document_item_date: type: string format: date-time description: The date when the debit memo item takes effect. example: '2022-01-01T07:08:12-07:00' taxation_items: type: object title: TaxationItemListResponse description: Information of the taxation items. additionalProperties: false properties: next_page: type: string nullable: true data: type: array items: $ref: '#/components/schemas/taxationItem' debit_memo: allOf: - $ref: '#/components/schemas/debitMemo' description: The related debit memo. debit_memo_id: type: string description: The related debit memo id. subscription: allOf: - $ref: '#/components/schemas/subscription' readOnly: true description: List of customer subscriptions. subscription_item: allOf: - $ref: '#/components/schemas/subscriptionItem' description: >- The expandable subscription item associated with this billing document item. debitMemoItemApplicationRequest: type: object title: DebitMemoItemApplicationRequest description: '' nullable: false additionalProperties: false properties: id: type: string description: Identifier of a memo item. amount: type: number description: >- The amount of the payment that is applied to the specific billing document item or taxation item. taxation_item_id: type: string description: Identifier of the taxation item to which the payment is applied. required: - id - amount payDebitMemoRequest: type: object title: PayDebitMemoRequest description: '' additionalProperties: false properties: amount: type: number description: The amount of the payment. account_id: type: string description: Identifier of the account that owns the debit memo. account_number: type: string description: Human-readable identifier of the account that owns the debit memo. authorization_id: type: string description: >- Identifier of the authorization transaction from the payment gateway. description: type: string description: >- An arbitrary string attached to the object. Often useful for displaying to users. currency: type: string description: 3-letter ISO 4217 currency code. bank_account_account: type: string description: An active account in your Zuora Chart of Accounts. payment_date: type: string format: date description: The date and time when the payment takes effect. payment_method_id: type: string description: Identifier of the payment method used to create this payment. gateway_id: type: string description: >- Identifier of the payment gateway that Zuora will use to authorize this payment. gateway_order_id: type: string description: >- A merchant-specified natural key value that can be passed to the payment gateway when a payment is created. If not specified, the payment number will be passed in instead. reference_id: type: string description: >- A second transaction identifier returned by the payment gateway if there is an additional transaction for the refunds. You may use this field to reconcile payments between your payment gateway and Zuora Payments. gateway_options: type: object additionalProperties: type: string example: key: value statement_descriptor: type: string description: A payment gateway-specific field used by Orbital, Vantiv and Verifi. statement_descriptor_phone: type: string description: A payment gateway-specific field used by Orbital, Vantiv and Verifi. external: type: boolean description: If true, indicates that this payment is not handled by Zuora. custom_fields: $ref: '#/components/schemas/customFields' required: - currency debitMemoItemCreateRequest: type: object title: DebitMemoItemCreateRequest description: '' additionalProperties: false properties: amount: type: number description: >- Amount of the memo item. This should always be equal to unit_amount * quantity. description: type: string description: >- An arbitrary string associated with the object. Often useful for displaying to users. deferred_revenue_account: type: string description: An active account in your Zuora Chart of Accounts. on_account_account: type: string description: An active account in your Zuora Chart of Accounts. recognized_revenue_account: type: string description: An active account in your Zuora Chart of Accounts. revenue_recognition_rule_name: type: string description: >- The name of the revenue recognition rule governing the revenue schedule. quantity: type: number description: The number of units of this item. service_end: type: string format: date description: >- The end date of the service period associated with this debit memo item. If the price for the associated subscription item is a one-time fee, then this date is the date of that subscription item. example: '2022-01-01' service_start: type: string format: date description: >- The start date of the service period associated with this debit memo item. If the price for the associated subscription item is a one-time fee, then this date is the date of that subscription item. example: '2022-01-01' sku: type: string description: >- The unique SKU (stock keeping unit) of the product associated with this item. tax_inclusive: type: boolean description: >- Indicates whether the debit memo item amount is inclusive or exclusive of tax. unit_of_measure: type: string description: Specifies the units used to measure usage. taxation_items: type: array items: $ref: '#/components/schemas/taxationItemCreateRequest' description: List of taxation items. unit_amount: type: number description: Unit amount of the debit memo item. price_id: type: string description: The identifier of the price this debit memo item is associated with. purchase_order_number: type: string description: The purchase order number associated with this debit memo item. tax_code: type: string description: The designated tax code. name: type: string description: >- Name of the debit memo item displayed to customers on the billing document. invoice_item_id: type: string description: >- The identifier of the invoice item associated with this debit memo item. accounting_code: type: string document_item_date: type: string format: date-time description: >- The date when the billing document item takes effect. This field is applicable only if the `type` field is set to `invoice`. example: '2022-01-01T07:08:12-07:00' custom_fields: $ref: '#/components/schemas/customFields' required: - service_start debitMemoItemListResponse: type: object title: DebitMemoItemListResponse description: '' nullable: false additionalProperties: false properties: next_page: type: string nullable: true data: type: array items: $ref: '#/components/schemas/debitMemoItem' creditMemo: type: object title: CreditMemo description: '' nullable: false additionalProperties: false properties: id: type: string readOnly: true description: Unique identifier for the object. updated_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who last updated the object updated_time: type: string format: date-time readOnly: true description: >- The date and time when the object was last updated in ISO 8601 UTC format. created_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who created the object created_time: type: string format: date-time readOnly: true description: >- The date and time when the object was created in ISO 8601 UTC format. custom_fields: type: object title: CustomFields description: >- Set of user-defined fields associated with this object. Useful for storing additional information about the object in a structured format. x-extra-field-annotation: '@JsonAdapter(CustomFieldAdapter.class)' additionalProperties: true custom_objects: oneOf: - $ref: '#/components/schemas/listCustomObjectResponse' - $ref: '#/components/schemas/custom_object' readOnly: true description: The custom objects associated with a Zuora standard object. account_id: type: string description: >- Identifier of the account that owns the credit memo. Either this field or `account_number` is required when creating credit memos from a price(charge in the v1 API). account_number: type: string description: >- Human-readable identifier of the account that owns the credit memo. Either this field or `account_id` is required when creating credit memos from a price(charge in the v1 API). example: RC-00020831 description: type: string description: >- An arbitrary string associated with the object. Often useful for displaying to users. document_date: type: string format: date description: The date when the credit memo takes effect. example: '2023-01-01' reason_code: type: string description: Reason for issuing this credit memo invoice_id: type: string description: >- The identifier of the invoice billing document from which this credit memo is created. **Required when creating credit memos from an invoice.** transfer_to_accounting: type: boolean description: Whether to transfer to an external accounting system. exclude_from_auto_apply_rules: type: boolean description: >- Indicates whether to exclude this credit memo from the rule of automatically applying it to invoices. credit_memo_number: type: string readOnly: true description: >- A human-readable identifier for the billing document; may be user-supplied. amount_refunded: type: number description: The amount this billing document refunded. state_transitions: allOf: - type: object properties: posted_time: type: string readOnly: true canceled_time: type: string readOnly: true posted_by_id: type: string readOnly: true description: Identifier of the Zuora user who posted the billing document. state: type: string enum: - draft - posted - canceled - failed description: The status of the billing document. account: allOf: - $ref: '#/components/schemas/account' description: The account that owns the billing document. EXPANDABLE items: allOf: - $ref: '#/components/schemas/creditMemoItemListResponse' readOnly: true description: List of billing document items. EXPANDABLE total: type: number readOnly: true description: The total amount. subtotal: type: number readOnly: true description: The total amount exclusive of tax. tax: type: number readOnly: true description: The total tax amount. balance: type: number readOnly: true deprecated: true description: >- The total balance remaining. This field is deprecated. Use `remaining_balance` field. remaining_balance: type: number readOnly: true description: The total balance remaining. applied_to: type: array items: $ref: '#/components/schemas/creditMemoAppliedToResponse' readOnly: true bill_to_id: type: string nullable: true x-extra-field-annotation: '@JsonAdapter(NullableFieldAdapter.class)' description: ID of the bill-to contact. example: 2c92c0f86a8dd422016a9e7a70116b0d bill_to: allOf: - $ref: '#/components/schemas/contact' readOnly: true description: The billing address for the customer. billing_document_settings: allOf: - $ref: '#/components/schemas/flexibleBillingDocumentSettings' description: The billing document settings for the customer. creditMemoListResponse: type: object title: CreditMemoListResponse description: '' nullable: false additionalProperties: false properties: next_page: type: string nullable: true data: type: array items: $ref: '#/components/schemas/creditMemo' creditMemoCreateRequest: type: object title: CreditMemoCreateRequest description: '' nullable: false additionalProperties: false properties: account_id: type: string description: >- Identifier of the account that owns the credit memo. Either this field or `account_number` is required when creating credit memos from a price(charge in the v1 API). account_number: type: string description: >- Human-readable identifier of the account that owns the credit memo. Either this field or `account_id` is required when creating credit memos from a price(charge in the v1 API). example: RC-00020831 description: type: string description: >- An arbitrary string associated with the object. Often useful for displaying to users. document_date: type: string format: date description: The date when the credit memo takes effect. example: '2023-01-01' reason_code: type: string description: Reason for issuing this credit memo invoice_id: type: string description: >- The identifier of the invoice billing document from which this credit memo is created. **Required when creating credit memos from an invoice.** transfer_to_accounting: type: boolean description: Whether to transfer to an external accounting system. custom_fields: $ref: '#/components/schemas/customFields' exclude_from_auto_apply_rules: type: boolean description: >- Indicates whether to exclude this credit memo from the rule of automatically applying it to invoices. items: type: array items: $ref: '#/components/schemas/creditMemoItemCreateRequest' description: Information of all credit memo items. apply: type: boolean description: Whether to automatically apply the billing document upon posting. post: type: boolean description: >- Whether to automatically post a billing document after it is created. creditMemoItem: type: object title: CreditMemoItem description: '' nullable: false additionalProperties: false properties: id: type: string readOnly: true description: Unique identifier for the object. updated_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who last updated the object updated_time: type: string format: date-time readOnly: true description: >- The date and time when the object was last updated in ISO 8601 UTC format. created_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who created the object created_time: type: string format: date-time readOnly: true description: >- The date and time when the object was created in ISO 8601 UTC format. custom_fields: type: object title: CustomFields description: >- Set of user-defined fields associated with this object. Useful for storing additional information about the object in a structured format. x-extra-field-annotation: '@JsonAdapter(CustomFieldAdapter.class)' additionalProperties: true custom_objects: oneOf: - $ref: '#/components/schemas/listCustomObjectResponse' - $ref: '#/components/schemas/custom_object' readOnly: true description: The custom objects associated with a Zuora standard object. amount: type: number description: The total amount of this credit memo item. subtotal: type: number description: The total amount of this credit memo item exclusive of tax. description: type: string description: >- An arbitrary string associated with the object. Often useful for displaying to users. deferred_revenue_account: type: string description: >- The accounting code for the deferred revenue, such as Monthly Recurring Liability. on_account_account: type: string description: >- The accounting code that maps to an on account in your accounting system. recognized_revenue_account: type: string description: >- The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges. credit_memo: allOf: - $ref: '#/components/schemas/creditMemo' description: The related credit memo. credit_memo_id: type: string description: The related credit memo id. revenue_recognition_rule_name: type: string description: >- The name of the revenue recognition rule governing the revenue schedule. quantity: type: number description: The number of units of this item. service_end: type: string description: >- The end date of the service period associated with this credit memo item. If the associated charge is a one-time fee, then this date is the date of that charge. service_start: type: string description: >- The start date of the service period associated with this credit memo item. If the associated charge is a one-time fee, then this date is the date of that charge. accounts_receivable_account: type: string description: An active account in your Zuora Chart of Accounts. discount_item: type: boolean description: If true, indicates that the item is a discount item. applied_to_item_id: type: string description: >- Identifier of an invoice item that this credit memo item is applied to. accounting_code: type: string description: An active account in your Zuora Chart of Accounts. sku: type: string description: >- The unique SKU (stock keeping unit) of the product associated with this item. tax_inclusive: type: boolean description: >- This specifies if the credit memo item amount is inclusive or exclusive of tax. remaining_balance: type: number description: The remaining balance of this credit memo item. unit_of_measure: type: string description: Specifies the units used to measure usage. unit_amount: type: number description: Unit amount of the credit memo item. name: type: string description: >- Name of the credit memo item displayed to customers on the billing document. price_id: type: string description: >- The identifier of the price this credit memo item is associated with. purchase_order_number: type: string description: The purchase order number associated with this credit memo item. tax: type: number description: The amount of tax applied to the credit memo item. tax_code: type: string description: The designated tax code. subscription_id: type: string description: >- The identifier of the subscription associated with the credit memo item. subscription_item_id: type: string description: >- The identifier the subscription item associated with this credit memo item. invoice_item_id: type: string description: >- The identifier of the invoice item associated with this credit memo item. document_item_date: type: string format: date-time description: The date when the credit memo item takes effect. example: '2022-01-01T07:08:12-07:00' taxation_items: type: object title: TaxationItemListResponse description: Information of the taxation items. additionalProperties: false properties: next_page: type: string nullable: true data: type: array items: $ref: '#/components/schemas/taxationItem' subscription: allOf: - $ref: '#/components/schemas/subscription' readOnly: true description: List of customer subscriptions. subscription_item: allOf: - $ref: '#/components/schemas/subscriptionItem' description: >- The expandable subscription item associated with this billing document item. creditMemoItemListResponse: type: object title: CreditMemoItemListResponse description: '' nullable: false additionalProperties: false properties: next_page: type: string nullable: true data: type: array items: $ref: '#/components/schemas/creditMemoItem' creditMemoItemCreateRequest: type: object title: CreditMemoItemCreateRequest description: '' additionalProperties: false properties: amount: type: number description: >- Amount of the credit memo item. This should always be equal to unit_amount * quantity. Required when creating credit memos from an invoice. description: type: string description: >- An arbitrary string associated with the object. Often useful for displaying to users. deferred_revenue_account: type: string description: An active account in your Zuora Chart of Accounts. on_account_account: type: string description: An active account in your Zuora Chart of Accounts. recognized_revenue_account: type: string description: An active account in your Zuora Chart of Accounts. revenue_recognition_rule_name: type: string description: >- The name of the revenue recognition rule governing the revenue schedule. quantity: type: number description: The number of units of this item. service_end: type: string format: date description: >- The end date of the service period associated with this credit memo item. If the price for the associated subscription item is a one-time fee, then this date is the date of that subscription item. example: '2022-01-01' service_start: type: string format: date description: >- The start date of the service period associated with this credit memo item. If the price for the associated subscription item is a one-time fee, then this date is the date of that subscription item. example: '2022-01-01' sku: type: string description: >- The unique SKU (stock keeping unit) of the product associated with this item. tax_inclusive: type: boolean description: >- Indicates whether the credit memo item amount is inclusive or exclusive of tax. unit_of_measure: type: string description: Specifies the units used to measure usage. taxation_items: type: array items: $ref: '#/components/schemas/taxationItemCreateRequest' description: List of taxation items. unit_amount: type: number description: Unit amount of the credit memo item. price_id: type: string description: >- The identifier of the price this credit memo item is associated with. Required when creating credit memos from a price(charge in the v1 API). purchase_order_number: type: string description: >- The purchase order number associated with this billing document item. tax_code: type: string description: The designated tax code. name: type: string description: >- Name of the billing document item displayed to customers on the billing document. **Required when creating credit memos from an invoice** invoice_item_id: type: string description: >- The identifier of the invoice item associated with this credit memo item. **Required when creating credit memos from an invoice.** accounting_code: type: string description: An active account in your Zuora Chart of Accounts. custom_fields: $ref: '#/components/schemas/customFields' required: - service_start refundCreditMemoItemRequest: type: object title: RefundCreditMemoItemRequest description: '' nullable: false additionalProperties: false properties: id: type: string description: Identifier of the credit memo item amount: type: number description: Refund amount. tax_item_id: type: string description: Identifier of the credit memo taxation item required: - amount refundCreditMemoTaxationItemRequest: type: object title: RefundCreditMemoTaxationItemRequest description: '' nullable: false additionalProperties: false properties: id: type: string description: Identifier of the credit memo taxation item amount: type: number description: Refund amount. required: - amount refundCreditMemoRequest: type: object title: RefundCreditMemoRequest description: '' nullable: false additionalProperties: false properties: id: type: string description: Identifier of the credit memo taxation item amount: type: number description: Refund amount. credit_memo_items: type: array items: $ref: '#/components/schemas/refundCreditMemoItemRequest' description: The items to which the credit memo is applied. taxation_items: type: array items: $ref: '#/components/schemas/refundCreditMemoItemRequest' description: The items to which the credit memo is applied. required: - amount creditMemoAppliedToResponse: type: object title: CreditMemoAppliedToResponse description: '' nullable: false additionalProperties: false properties: billing_document_id: type: string description: Identifier of an invoice or a debit memo. id: type: string description: Identifier of the credit memo application amount: type: number description: >- The amount of the payment that is applied to the specific billing document item or taxation item. billing_document: allOf: - $ref: '#/components/schemas/billingDocument' description: The related billing document. billing_document_type: type: string enum: - debit_memo - invoice description: >- The type of billing document. Can be one of the debit memo or invoice. creditMemoItemApplicationRequest: type: object title: CreditMemoItemApplicationRequest description: '' additionalProperties: false properties: credit_memo_item_id: type: string description: The identifier of the credit memo item to apply. amount: type: number description: >- The credit memo amount applied to this billing document item or taxation item. credit_memo_taxation_item_id: type: string description: The identifier of the credit memo taxation item to apply. taxation_item_id: type: string description: The identifier of a taxation item. id: type: string description: The identifier of an invoice item or debit memo item. required: - amount applyUnapplyCreditMemo: type: object title: ApplyUnapplyCreditMemo description: '' additionalProperties: false properties: effective_date: type: string format: date description: The date when the credit memo is applied example: '2023-01-01' billing_documents: type: array items: $ref: '#/components/schemas/creditMemoApplicationRequest' description: Array of billing documents to apply this credit memo to. required: - billing_documents creditMemoApplicationRequest: type: object title: CreditMemoApplicationRequest description: '' additionalProperties: false properties: id: type: string description: >- Identifier of the invoice or debit memo to which the credit memo is applied. type: type: string enum: - debit_memo - invoice description: The type of billing document, one of invoice or debit_memo. amount: type: number description: The credit memo amount applied to this billing document. items: type: array items: $ref: '#/components/schemas/creditMemoItemApplicationRequest' description: >- The billing document items (invoice items or debit memo items or taxation items) to which the credit memo is applied. required: - type - id - amount creditMemoPatchRequest: type: object title: CreditMemoPatchRequest description: '' nullable: false additionalProperties: false properties: apply: type: boolean description: Whether to automatically apply the billing document upon posting. document_date: type: string format: date description: The date when the credit memo is applied example: '2023-01-01' reason_code: type: string description: Reason for issuing this credit memo transfer_to_accounting: type: boolean description: Whether to transfer to an external accounting system. exclude_from_auto_apply_rules: type: boolean description: >- Indicates whether to exclude this credit memo from the rule of automatically applying it to invoices. description: type: string description: >- An arbitrary string associated with the object. Often useful for displaying to users. custom_fields: $ref: '#/components/schemas/customFields' refundStateTransitions: type: object title: RefundStateTransitions description: The timestamps at which the object's state was updated. additionalProperties: false properties: canceled_time: type: string format: date-time description: >- The date and time (ISO 8601 UTC format) when the refund was canceled. refunded_time: type: string format: date-time refund: type: object title: Refund description: '' nullable: false additionalProperties: false properties: id: type: string updated_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who last updated the object updated_time: type: string format: date-time readOnly: true description: >- The date and time when the object was last updated in ISO 8601 UTC format. created_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who created the object created_time: type: string format: date-time readOnly: true description: >- The date and time when the object was created in ISO 8601 UTC format. custom_fields: type: object title: CustomFields description: >- Set of user-defined fields associated with this object. Useful for storing additional information about the object in a structured format. x-extra-field-annotation: '@JsonAdapter(CustomFieldAdapter.class)' additionalProperties: true custom_objects: oneOf: - $ref: '#/components/schemas/listCustomObjectResponse' - $ref: '#/components/schemas/custom_object' readOnly: true description: The custom objects associated with a Zuora standard object. amount: type: number description: Refund amount. description: type: string description: >- An arbitrary string attached to the object. Often useful for displaying to users. gateway_options: type: object additionalProperties: type: string example: key: value refund_date: type: string format: date description: The date when the refund takes effect. refund_method_type: type: string enum: - cash - check - wire_transfer - pay_pal - credit_card - cc_ref - ach_debit - debit_card - other payment_id: type: string readOnly: true description: Identifier for the payment, either `payment_number` or `payment_id. reason_code: type: string description: User-provided reason for the refund. statement_descriptor: type: string description: A payment gateway-specific field used by Orbital, Vantiv and Verifi. statement_descriptor_phone: type: string description: A payment gateway-specific field used by Orbital, Vantiv and Verifi. external: type: boolean description: If true, indicates that this refund is not handled by Zuora. reference_id: type: string description: >- Transaction identifier returned by the payment gateway. You may use this field to reconcile refunds between your payment gateway and Zuora Payments. second_reference_id: type: string description: >- A second transaction identifier returned by the payment gateway if there is an additional transaction for the refunds. You may use this field to reconcile payments between your payment gateway and Zuora Payments. bank_account_account: type: string description: An active account in your Zuora Chart of Accounts. on_account_account: type: string description: An active account in your Zuora Chart of Accounts. unapplied_payment_account: type: string description: An active account in your Zuora Chart of Accounts. payment_method_id: type: string readOnly: true description: Identifier of the payment method used to create this refund. credit_memo: allOf: - $ref: '#/components/schemas/refundCreditMemoRequest' description: The related credit memo. account_id: type: string description: Identifier of the customer this refund is for, if one exists. account: allOf: - $ref: '#/components/schemas/account' description: The account that owns the refund gateway_id: type: string description: >- Identifier of the payment gateway that Zuora will use to authorize the payments that are made with this payment method. If you do not set this field, Zuora will use one of the following payment gateways instead: The default payment gateway of the customer account that owns the payment method, if the payment method is associated with a customer account or the default payment gateway of your Zuora tenant. comment: type: string description: Comments about the refund. gateway_response: type: string readOnly: true description: Message returned by the payment gateway for this refund. gateway_response_code: type: string readOnly: true description: Code returned by the payment gateway for this refund. gateway_state: type: string enum: - marked_for_submission - submitted - settled - not_submitted - failed readOnly: true description: The payment gateway state of the refund. payment_method: type: object title: PaymentMethod description: Payment method information. additionalProperties: false properties: id: type: string readOnly: true description: Unique identifier for the object. updated_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who last updated the object updated_time: type: string format: date-time readOnly: true description: >- The date and time when the object was last updated in ISO 8601 UTC format. created_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who created the object created_time: type: string format: date-time readOnly: true description: >- The date and time when the object was created in ISO 8601 UTC format. custom_fields: type: object title: CustomFields description: >- Set of user-defined fields associated with this object. Useful for storing additional information about the object in a structured format. x-extra-field-annotation: '@JsonAdapter(CustomFieldAdapter.class)' additionalProperties: true custom_objects: oneOf: - $ref: '#/components/schemas/listCustomObjectResponse' - $ref: '#/components/schemas/custom_object' readOnly: true description: The custom objects associated with a Zuora standard object. type: type: string enum: - paypal_express - paypal_express_native - paypal_adaptive - card - cc_ref - ach_debit - sepa_debit - betalings_debit - autogiro_debit - bacs_debit - au_becs_debit - nz_becs_debit - pad_debit - apple_pay - wire_transfer - check - cash - other - paypal - adyen_google_pay - adyen_apple_pay description: >- The type of the payment method. An additional hash is included on the payment method with a name matching this value. It contains additional information specific to the payment method type. custom_type: type: string description: >- The custom type of the payment method from Universal Payment Connector. account_id: type: string description: A customer account identifier. example: 2c92c0f86a8dd422016a9e7a70116b0d account: allOf: - $ref: '#/components/schemas/account' readOnly: true description: The customer account associated with this payment method. billing_details: type: object title: BillingDetails description: >- Billing information associated with the payment method that may be used or required by specific payment method types. additionalProperties: false properties: name: type: string description: Customer full name or business name. example: Amy Lawrence address: type: object title: AddressFieldDefinitions description: Address information used in billing details. additionalProperties: false properties: line1: type: string description: Address line 1 (e.g., street, PO Box, or company name). example: 3333 Piedmont Rd NE line2: type: string description: >- Address line 2 (e.g., apartment, suite, unit, or building). example: Suite 1150 city: type: string description: City, district, suburb, town, or village. example: Atlanta country: type: string description: The country of the contact's address. example: United States state: type: string description: The state, county, province, or region. example: GA postal_code: type: string description: ZIP or postal code. example: '30305' email: type: string description: Customer email address. example: alawrence@gmail.com phone: type: string description: Customer phone (including extension). example: (888)976-9056 maximum_payment_attempts: type: number description: >- Maximum number of consecutive failed retry payment attempts using this payment method before retries are stopped. example: 6 payment_retry_interval: type: integer description: The retry interval in hours. example: 3 device_session_id: type: string ip_address: type: string nullable: true description: >- The IP address from which the Mandate was accepted by the customer. example: 192.10.1.123 bank_identification_number: type: string card: type: object title: GetCardList description: Credit card information. additionalProperties: false properties: brand: type: string enum: - visa - mastercard - american_express - discover - jcb - diners description: Card brand. expiry_month: type: number description: One or two digit expiration month (1-12) of the credit card. example: 10 expiry_year: type: number description: >- Two- or four-digit number representing the card's expiration year. example: 2024 mandate: type: object title: Mandate description: >- The mandate information for the Credit Card, Credit Card Reference Transaction, ACH, or Bank Transfer payment method. additionalProperties: false properties: id: type: string description: >- Identifier of the single- or multi-use mandate generated by the payment gateway. reason: type: string description: Reason for the mandate. state: type: string enum: - active - canceled - expired - agreed readOnly: true description: >- The status of the mandate, which indicates whether it can be used to initiate a payment. last_4: type: string readOnly: true description: The last four digits of the card number. example: '2042' paypal_express_native: type: object title: PaypalExpressNative description: >- If it is a `paypal_express_native` payment method, this hash contains details about the PayPal Express Native payment method. additionalProperties: false properties: baid: type: string description: >- Identifier of a PayPal billing agreement. For example, I-1TJ3GAGG82Y9. email: type: string description: >- Email address associated with the payment method. This is required with a paypal_express_checkout or a paypal_adaptive payment method. required: - baid paypal_express: type: object title: PaypalExpress description: >- If it is a `paypal_express` payment method, this hash contains details about the PayPal Express payment method. additionalProperties: false properties: baid: type: string description: >- Identifier of a PayPal billing agreement. For example, I-1TJ3GAGG82Y9. email: type: string description: Email address associated with the payment method required: - baid - email paypal_adaptive: type: object title: PaypalAdaptive description: >- If it is a `paypal_adaptive` payment method, this hash contains details about the PayPal Adaptive payment method. additionalProperties: false properties: preapproval_key: type: string description: PayPal preapproval key. example: 2G4EPFSD email: type: string description: Email address associated with the payment method. example: alawrence@zuora.com required: - preapproval_key - email sepa_debit: type: object title: SepaDebit description: >- If the `type` of the payment method is `sepa_debit`, this hash contains details about the SEPA bank account. additionalProperties: false properties: IBAN: type: string description: >- International Bank Account Number used to create the SEPA Debit payment method. mandate: type: object title: Mandate description: >- The mandate information for the Credit Card, Credit Card Reference Transaction, ACH, or Bank Transfer payment method. additionalProperties: false properties: id: type: string description: >- Identifier of the single- or multi-use mandate generated by the payment gateway. reason: type: string description: Reason for the mandate. state: type: string enum: - active - canceled - expired - agreed readOnly: true description: >- The status of the mandate, which indicates whether it can be used to initiate a payment. business_identification_code: type: string description: The BIC code used with the Sepa Debit payment method. required: - IBAN cc_ref: type: object title: CcRef description: >- If the `type` of the payment method is `cc_ref`, this hash contains details about the Credit Card Reference Transactions payment method. See [Supported payment methods](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/A_Supported_Payment_Methods) for payment gateways that support this type of payment method. additionalProperties: false properties: second_token: type: string description: >- A gateway unique identifier that replaces sensitive payment method data. This field is conditionally required only when `token` is being used to represent a gateway customer profile. token: type: string description: >- A gateway unique identifier that replaces sensitive payment method data or represents a gateway's unique customer profile. When `token` is used to represent a customer profile, `second_token` is conditionally required for representing the underlying tokenized payment method. mandate: type: object title: Mandate description: >- The mandate information for the Credit Card, Credit Card Reference Transaction, ACH, or Bank Transfer payment method. additionalProperties: false properties: id: type: string description: >- Identifier of the single- or multi-use mandate generated by the payment gateway. reason: type: string description: Reason for the mandate. state: type: string enum: - active - canceled - expired - agreed readOnly: true description: >- The status of the mandate, which indicates whether it can be used to initiate a payment. card: type: object title: CcRefCard description: '' nullable: false additionalProperties: false properties: brand: type: string enum: - visa - mastercard - american_express - discover - jcb - diners description: Card brand. expiry_month: type: number description: >- One or two digit expiration month (1-12) of the credit card. example: 10 expiry_year: type: number description: >- Two- or four-digit number representing the card's expiration year. example: 2024 last_4: type: string readOnly: true description: The last four digits of the card number. example: '2042' required: - token apple_pay: type: object title: ApplePay description: >- If the `type` of the payment method is `apple_pay`, this hash contains details about the Apple Pay payment method. See [Supported payment methods](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/A_Supported_Payment_Methods) for payment gateways that support this type of payment method. additionalProperties: false properties: card: allOf: - $ref: '#/components/schemas/getCardList' description: >- Credit card information. When providing a card number, you must meet the requirements for PCI compliance. We strongly recommend using Zuora.js instead of interacting with this API directly. mandate: type: object title: Mandate description: >- The mandate information for the Credit Card, Credit Card Reference Transaction, ACH, or Bank Transfer payment method. additionalProperties: false properties: id: type: string description: >- Identifier of the single- or multi-use mandate generated by the payment gateway. reason: type: string description: Reason for the mandate. state: type: string enum: - active - canceled - expired - agreed readOnly: true description: >- The status of the mandate, which indicates whether it can be used to initiate a payment. payment_id: type: string description: >- The ID of newly processed payment. Only available in the response of the Create Payment Method API request. token: type: string description: >- A gateway unique identifier that replaces sensitive payment method data or represents a gateway's unique customer profile. When `token` is used to represent a customer profile, `second_token` is conditionally required for representing the underlying tokenized payment method. google_pay: type: object title: GooglePay description: >- If the `type` of the payment method is `apple_pay`, this hash contains details about the Apple Pay payment method. See [Supported payment methods](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/A_Supported_Payment_Methods) for payment gateways that support this type of payment method. additionalProperties: false properties: card: allOf: - $ref: '#/components/schemas/getCardList' description: >- Credit card information. When providing a card number, you must meet the requirements for PCI compliance. We strongly recommend using Zuora.js instead of interacting with this API directly. token: type: string description: >- A gateway unique identifier that replaces sensitive payment method data or represents a gateway's unique customer profile. When `token` is used to represent a customer profile, `second_token` is conditionally required for representing the underlying tokenized payment method. ach_debit: type: object title: AchDebit description: >- If the `type` of the payment method is `ach_debit`, this hash contains details about the ACH bank account. additionalProperties: false properties: mandate: type: object title: Mandate description: >- The mandate information for the Credit Card, Credit Card Reference Transaction, ACH, or Bank Transfer payment method. additionalProperties: false properties: id: type: string description: >- Identifier of the single- or multi-use mandate generated by the payment gateway. reason: type: string description: Reason for the mandate. state: type: string enum: - active - canceled - expired - agreed readOnly: true description: >- The status of the mandate, which indicates whether it can be used to initiate a payment. bank_aba_code: type: string description: The nine-digit routing number or ABA number used by banks. bank_account_name: type: string description: >- The name of the account holder, which can be either a person or a company. bank_account_type: type: string enum: - business_saving - business_checking - checking - saving description: The type of bank account associated with the payment method. bank_name: type: string description: Name of the bank associated with this bank account. bank_account_number: type: string description: The bank account number of the account holder. required: - bank_aba_code - bank_account_type - bank_account_name - bank_account_number - bank_name betalings_debit: type: object title: BetalingsDebit description: >- If the `type` of the payment method is `betalings_debit`, this hash contains details about the Betalingsservice bank account. additionalProperties: false properties: account_number: type: string description: The bank account number of the account holder. identity_number: type: string description: >- The identity number used for Betalingsservice (Direct Debit DK). bank_code: type: string description: Identifier of the bank associated with this bank account. mandate: type: object title: Mandate description: >- The mandate information for the Credit Card, Credit Card Reference Transaction, ACH, or Bank Transfer payment method. additionalProperties: false properties: id: type: string description: >- Identifier of the single- or multi-use mandate generated by the payment gateway. reason: type: string description: Reason for the mandate. state: type: string enum: - active - canceled - expired - agreed readOnly: true description: >- The status of the mandate, which indicates whether it can be used to initiate a payment. required: - account_number - identity_number - bank_code autogiro_debit: type: object title: AutogiroDebit description: >- If the `type` of the payment method is `autogiro_debit`, this hash contains details about the Autogiro bank account. additionalProperties: false properties: account_number: type: string description: The bank account number of the account holder. identity_number: type: string description: The identity number used for Autogiro (Direct Debit SE). branch_code: type: string description: >- Identifier of the bank branch associated with this bank account. mandate: type: object title: Mandate description: >- The mandate information for the Credit Card, Credit Card Reference Transaction, ACH, or Bank Transfer payment method. additionalProperties: false properties: id: type: string description: >- Identifier of the single- or multi-use mandate generated by the payment gateway. reason: type: string description: Reason for the mandate. state: type: string enum: - active - canceled - expired - agreed readOnly: true description: >- The status of the mandate, which indicates whether it can be used to initiate a payment. required: - account_number - identity_number - branch_code bacs_debit: type: object title: BacsDebit description: >- If the `type` of the payment method is `bacs_debit`,, this hash contains details about the BACS bank account. additionalProperties: false properties: account_number: type: string description: The bank account number of the account holder. bank_code: type: string description: Identifier of the bank associated with this bank account. mandate: type: object title: Mandate description: >- The mandate information for the Credit Card, Credit Card Reference Transaction, ACH, or Bank Transfer payment method. additionalProperties: false properties: id: type: string description: >- Identifier of the single- or multi-use mandate generated by the payment gateway. reason: type: string description: Reason for the mandate. state: type: string enum: - active - canceled - expired - agreed readOnly: true description: >- The status of the mandate, which indicates whether it can be used to initiate a payment. required: - account_number - bank_code au_becs_debit: type: object title: AuBecsDebit description: >- If the `type` of the payment method is `au_becs_debit`, this hash contains details about the BECS bank account. additionalProperties: false properties: account_number: type: string description: The bank account number of the account holder. branch_code: type: string description: >- Identifier of the bank branch associated with this bank account. mandate: type: object title: Mandate description: >- The mandate information for the Credit Card, Credit Card Reference Transaction, ACH, or Bank Transfer payment method. additionalProperties: false properties: id: type: string description: >- Identifier of the single- or multi-use mandate generated by the payment gateway. reason: type: string description: Reason for the mandate. state: type: string enum: - active - canceled - expired - agreed readOnly: true description: >- The status of the mandate, which indicates whether it can be used to initiate a payment. required: - account_number - branch_code nz_becs_debit: type: object title: NzBecsDebit description: >- If the `type` of the payment method is `nz_becs_debit`, this hash contains details about the BECS-NZ bank account. additionalProperties: false properties: account_number: type: string description: The bank account number of the account holder. branch_code: type: string description: >- Identifier of the bank branch associated with this bank account. bank_code: type: string description: Identifier of the bank associated with this bank account. mandate: type: object title: Mandate description: >- The mandate information for the Credit Card, Credit Card Reference Transaction, ACH, or Bank Transfer payment method. additionalProperties: false properties: id: type: string description: >- Identifier of the single- or multi-use mandate generated by the payment gateway. reason: type: string description: Reason for the mandate. state: type: string enum: - active - canceled - expired - agreed readOnly: true description: >- The status of the mandate, which indicates whether it can be used to initiate a payment. required: - account_number - branch_code - bank_code pad_debit: type: object title: PadDebit description: >- If the `type` of the payment method is `pad_debit`, this hash contains details about the PAD bank account. additionalProperties: false properties: account_number: type: string description: The bank account number of the account holder. branch_code: type: string description: >- Identifier of the bank branch associated with this bank account. bank_code: type: string description: Identifier of the bank associated with this bank account. mandate: type: object title: Mandate description: >- The mandate information for the Credit Card, Credit Card Reference Transaction, ACH, or Bank Transfer payment method. additionalProperties: false properties: id: type: string description: >- Identifier of the single- or multi-use mandate generated by the payment gateway. reason: type: string description: Reason for the mandate. state: type: string enum: - active - canceled - expired - agreed readOnly: true description: >- The status of the mandate, which indicates whether it can be used to initiate a payment. required: - account_number - branch_code - bank_code state: type: string enum: - active - closed - scrubbed description: The state of the payment method. auto_generated: type: boolean use_default_retry_rule: type: boolean existing_mandate: type: boolean last_failed_sale_transaction_time: type: string format: date-time last_transaction_time: type: string format: date-time last_transaction_status: type: string number_of_consecutive_failures: type: integer total_number_of_processed_payments: type: integer total_number_of_error_payments: type: integer refund_number: type: string description: Human-readable identifier for this object; may be user-supplied. state_transitions: type: object title: RefundStateTransitions description: The timestamps at which the object's state was updated. additionalProperties: false properties: canceled_time: type: string format: date-time description: >- The date and time (ISO 8601 UTC format) when the refund was canceled. refunded_time: type: string format: date-time state: type: string enum: - draft - posted - processing - processed - error - canceled readOnly: true description: The state of the refund. gateway_reconciliation_reason: type: string readOnly: true description: Gateway reconciliation reason. gateway_reconciliation_status: type: string readOnly: true description: Gateway reconciliation state. payout_id: type: string readOnly: true description: Identifier of the payout from the payment gateway. applied_to: type: array items: $ref: '#/components/schemas/refundsAppliedToResponse' readOnly: true refundCreateRequest: type: object title: RefundCreateRequest description: '' additionalProperties: false properties: amount: type: number description: Refund amount. description: type: string description: >- An arbitrary string attached to the object. Often useful for displaying to users. gateway_options: type: object additionalProperties: type: string example: key: value refund_date: type: string format: date description: The date when the refund takes effect. refund_method_type: type: string enum: - cash - check - wire_transfer - pay_pal - credit_card - cc_ref - ach_debit - debit_card - other payment_id: type: string readOnly: true description: Identifier for the payment, either `payment_number` or `payment_id. reason_code: type: string description: User-provided reason for the refund. statement_descriptor: type: string maxLength: 35 description: A payment gateway-specific field used by Orbital, Vantiv and Verifi. statement_descriptor_phone: type: string maxLength: 20 description: A payment gateway-specific field used by Orbital, Vantiv and Verifi. external: type: boolean description: If true, indicates that this refund is not handled by Zuora. reference_id: type: string description: >- Transaction identifier returned by the payment gateway. You may use this field to reconcile refunds between your payment gateway and Zuora Payments. second_reference_id: type: string description: >- A second transaction identifier returned by the payment gateway if there is an additional transaction for the refunds. You may use this field to reconcile payments between your payment gateway and Zuora Payments. bank_account_account: type: string description: An active account in your Zuora Chart of Accounts. on_account_account: type: string description: An active account in your Zuora Chart of Accounts. unapplied_payment_account: type: string description: An active account in your Zuora Chart of Accounts. custom_fields: $ref: '#/components/schemas/customFields' payment_method_id: type: string readOnly: true description: Identifier of the payment method used to create this refund. credit_memo: allOf: - $ref: '#/components/schemas/refundCreditMemoRequest' description: The related credit memo. billing_documents: type: array items: $ref: '#/components/schemas/billingDocumentPaymentApplicationRequest' description: >- Indicates to which billing documents (invoices or debit memos) is the refund applied. required: - amount refundPatchRequest: type: object title: RefundPatchRequest description: '' nullable: false additionalProperties: false properties: description: type: string description: >- An arbitrary string attached to the object. Often useful for displaying to users. reason_code: type: string description: User-provided reason for the refund. bank_account_account: type: string description: An active account in your Zuora Chart of Accounts. unapplied_payment_account: type: string description: An active account in your Zuora Chart of Accounts. reference_id: type: string description: >- Transaction identifier returned by the payment gateway. You may use this field to reconcile payments between your payment gateway and Zuora Payments. custom_fields: $ref: '#/components/schemas/customFields' refundListResponse: type: object title: RefundListResponse description: '' nullable: false additionalProperties: false properties: next_page: type: string nullable: true data: type: array items: $ref: '#/components/schemas/refund' refundsAppliedToResponse: type: object title: RefundsAppliedToResponse description: '' nullable: false additionalProperties: false properties: billing_document_id: type: string description: Identifier of an invoice or a debit memo. id: type: string description: Identifier of the refund application. billing_document: allOf: - $ref: '#/components/schemas/billingDocument' description: The related billing document. amount: type: number description: >- The amount of the payment that is applied to the specific billing document item or taxation item. billing_document_type: type: string enum: - credit_memo - invoice description: >- The type of billing document. Can be one of the credit memo or invoice. payment: allOf: - $ref: '#/components/schemas/payment' items: type: array items: $ref: '#/components/schemas/refundAppliedToItemResponse' description: The related credit memo item. refundAppliedToItemResponse: type: object title: RefundAppliedToItemResponse description: '' nullable: false additionalProperties: false properties: credit_memo_item_id: type: string description: Identifier of an invoice or a debit memo item. id: type: string description: Identifier of the payment application item. amount: type: number description: >- The amount of the payment that is applied to the specific billing document item. taxation_item_id: type: string description: Identifier of a taxation item. paymentPatchRequest: type: object title: PaymentPatchRequest description: '' nullable: false additionalProperties: false properties: id: type: string readOnly: true description: Unique identifier for the object. updated_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who last updated the object updated_time: type: string format: date-time readOnly: true description: >- The date and time when the object was last updated in ISO 8601 UTC format. created_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who created the object created_time: type: string format: date-time readOnly: true description: >- The date and time when the object was created in ISO 8601 UTC format. custom_fields: $ref: '#/components/schemas/customFields' custom_objects: oneOf: - $ref: '#/components/schemas/listCustomObjectResponse' - $ref: '#/components/schemas/custom_object' readOnly: true description: The custom objects associated with a Zuora standard object. description: type: string description: >- An arbitrary string attached to the object. Often useful for displaying to users. reference_id: type: string description: >- Transaction identifier returned by the payment gateway. You may use this field to reconcile payments between your payment gateway and Zuora Payments. paymentCreateRequest: type: object title: PaymentCreateRequest description: '' additionalProperties: false properties: id: type: string readOnly: true description: Unique identifier for the object. updated_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who last updated the object updated_time: type: string format: date-time readOnly: true description: >- The date and time when the object was last updated in ISO 8601 UTC format. created_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who created the object created_time: type: string format: date-time readOnly: true description: >- The date and time when the object was created in ISO 8601 UTC format. custom_fields: $ref: '#/components/schemas/customFields' custom_objects: oneOf: - $ref: '#/components/schemas/listCustomObjectResponse' - $ref: '#/components/schemas/custom_object' readOnly: true description: The custom objects associated with a Zuora standard object. description: type: string description: >- An arbitrary string attached to the object. Often useful for displaying to users. reference_id: type: string description: >- Transaction identifier returned by the payment gateway. You may use this field to reconcile payments between your payment gateway and Zuora Payments. account_id: type: string description: Identifier of the customer account associated with this payment. account_number: type: string description: >- Human-readable identifier of the account associated with this payment. It can be user-supplied. amount: type: number description: The total amount of the payment. authorization_id: type: string description: >- Identifier of the authorization transaction from the payment gateway. payment_date: type: string format: date description: The date and time when the payment takes effect. payment_method_id: type: string description: Identifier of the payment method used to create this payment. gateway_id: type: string description: >- Identifier of the payment gateway that Zuora will use to authorize this payment. gateway_order_id: type: string description: >- A merchant-specified natural key value that can be passed to the payment gateway when a payment is created. If not specified, the payment number will be passed in instead. second_reference_id: type: string description: >- A second transaction identifier returned by the payment gateway if there is an additional transaction for the refunds. You may use this field to reconcile payments between your payment gateway and Zuora Payments. gateway_options: type: object additionalProperties: type: string example: key: value statement_descriptor: type: string description: A payment gateway-specific field used by Orbital, Vantiv and Verifi. statement_descriptor_phone: type: string description: A payment gateway-specific field used by Orbital, Vantiv and Verifi. external: type: boolean description: If true, indicates that this payment is not handled by Zuora. currency: type: string description: 3-letter ISO 4217 currency code. billing_documents: type: array items: $ref: '#/components/schemas/billingDocumentPaymentApplicationRequest' description: >- Indicates to which billing documents (invoices or debit memos) are the payment applied. required: - payment_date - payment_method_id - currency - amount paymentStateTransitions: type: object title: PaymentStateTransitions description: The timestamps at which the object's state was updated. additionalProperties: false properties: canceled_time: type: string format: date-time description: >- The date and time (ISO 8601 UTC format) when the payment was canceled. gatewayStateTransitions: type: object title: GatewayStateTransitions description: '' nullable: false additionalProperties: false properties: marked_for_submission_time: type: string format: date-time readOnly: true description: >- The date and time (ISO 8601 UTC format) when the payment was marked for submission. settled_time: type: string format: date-time description: >- The date and time (ISO 8601 UTC format) when the payment was settled. submitted_time: type: string format: date-time description: >- The date and time (ISO 8601 UTC format) when the payment was submitted. payment: type: object title: Payment description: '' nullable: false additionalProperties: false properties: id: type: string readOnly: true description: Unique identifier for the object. updated_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who last updated the object updated_time: type: string format: date-time readOnly: true description: >- The date and time when the object was last updated in ISO 8601 UTC format. created_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who created the object created_time: type: string format: date-time readOnly: true description: >- The date and time when the object was created in ISO 8601 UTC format. custom_fields: type: object title: CustomFields description: >- Set of user-defined fields associated with this object. Useful for storing additional information about the object in a structured format. x-extra-field-annotation: '@JsonAdapter(CustomFieldAdapter.class)' additionalProperties: true custom_objects: oneOf: - $ref: '#/components/schemas/listCustomObjectResponse' - $ref: '#/components/schemas/custom_object' readOnly: true description: The custom objects associated with a Zuora standard object. description: type: string description: >- An arbitrary string attached to the object. Often useful for displaying to users. reference_id: type: string description: >- Transaction identifier returned by the payment gateway. You may use this field to reconcile payments between your payment gateway and Zuora Payments. account_id: type: string description: Identifier of the customer account associated with this payment. account_number: type: string description: >- Human-readable identifier of the account associated with this payment. It can be user-supplied. amount: type: number description: The total amount of the payment. authorization_id: type: string description: >- Identifier of the authorization transaction from the payment gateway. payment_date: type: string format: date description: The date and time when the payment takes effect. payment_method_id: type: string description: Identifier of the payment method used to create this payment. gateway_id: type: string description: >- Identifier of the payment gateway that Zuora will use to authorize this payment. gateway_order_id: type: string description: >- A merchant-specified natural key value that can be passed to the payment gateway when a payment is created. If not specified, the payment number will be passed in instead. second_reference_id: type: string description: >- A second transaction identifier returned by the payment gateway if there is an additional transaction for the refunds. You may use this field to reconcile payments between your payment gateway and Zuora Payments. gateway_options: type: object additionalProperties: type: string example: key: value statement_descriptor: type: string description: A payment gateway-specific field used by Orbital, Vantiv and Verifi. statement_descriptor_phone: type: string description: A payment gateway-specific field used by Orbital, Vantiv and Verifi. external: type: boolean description: If true, indicates that this payment is not handled by Zuora. currency: type: string description: 3-letter ISO 4217 currency code. account: allOf: - $ref: '#/components/schemas/account' description: The customer account associated with this payment. amount_applied: type: number description: The total amount applied. remaining_balance: type: number description: The total remaining balance. amount_refunded: type: number description: The total amount refunded. state: type: string enum: - draft - posted - processing - processed - error - canceled readOnly: true description: The state of the payment. payout_id: type: string description: Identifier of the payout associated with this payment. payment_number: type: string description: Human-readable identifier for this object; may be user-supplied. gateway_response_code: type: string description: Code returned by the payment gateway for this payment. payment_method: type: object title: PaymentMethod description: Payment method information. additionalProperties: false properties: id: type: string readOnly: true description: Unique identifier for the object. updated_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who last updated the object updated_time: type: string format: date-time readOnly: true description: >- The date and time when the object was last updated in ISO 8601 UTC format. created_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who created the object created_time: type: string format: date-time readOnly: true description: >- The date and time when the object was created in ISO 8601 UTC format. custom_fields: type: object title: CustomFields description: >- Set of user-defined fields associated with this object. Useful for storing additional information about the object in a structured format. x-extra-field-annotation: '@JsonAdapter(CustomFieldAdapter.class)' additionalProperties: true custom_objects: oneOf: - $ref: '#/components/schemas/listCustomObjectResponse' - $ref: '#/components/schemas/custom_object' readOnly: true description: The custom objects associated with a Zuora standard object. type: type: string enum: - paypal_express - paypal_express_native - paypal_adaptive - card - cc_ref - ach_debit - sepa_debit - betalings_debit - autogiro_debit - bacs_debit - au_becs_debit - nz_becs_debit - pad_debit - apple_pay - wire_transfer - check - cash - other - paypal - adyen_google_pay - adyen_apple_pay description: >- The type of the payment method. An additional hash is included on the payment method with a name matching this value. It contains additional information specific to the payment method type. custom_type: type: string description: >- The custom type of the payment method from Universal Payment Connector. account_id: type: string description: A customer account identifier. example: 2c92c0f86a8dd422016a9e7a70116b0d account: allOf: - $ref: '#/components/schemas/account' readOnly: true description: The customer account associated with this payment method. billing_details: type: object title: BillingDetails description: >- Billing information associated with the payment method that may be used or required by specific payment method types. additionalProperties: false properties: name: type: string description: Customer full name or business name. example: Amy Lawrence address: type: object title: AddressFieldDefinitions description: Address information used in billing details. additionalProperties: false properties: line1: type: string description: Address line 1 (e.g., street, PO Box, or company name). example: 3333 Piedmont Rd NE line2: type: string description: >- Address line 2 (e.g., apartment, suite, unit, or building). example: Suite 1150 city: type: string description: City, district, suburb, town, or village. example: Atlanta country: type: string description: The country of the contact's address. example: United States state: type: string description: The state, county, province, or region. example: GA postal_code: type: string description: ZIP or postal code. example: '30305' email: type: string description: Customer email address. example: alawrence@gmail.com phone: type: string description: Customer phone (including extension). example: (888)976-9056 maximum_payment_attempts: type: number description: >- Maximum number of consecutive failed retry payment attempts using this payment method before retries are stopped. example: 6 payment_retry_interval: type: integer description: The retry interval in hours. example: 3 device_session_id: type: string ip_address: type: string nullable: true description: >- The IP address from which the Mandate was accepted by the customer. example: 192.10.1.123 bank_identification_number: type: string card: type: object title: GetCardList description: Credit card information. additionalProperties: false properties: brand: type: string enum: - visa - mastercard - american_express - discover - jcb - diners description: Card brand. expiry_month: type: number description: One or two digit expiration month (1-12) of the credit card. example: 10 expiry_year: type: number description: >- Two- or four-digit number representing the card's expiration year. example: 2024 mandate: type: object title: Mandate description: >- The mandate information for the Credit Card, Credit Card Reference Transaction, ACH, or Bank Transfer payment method. additionalProperties: false properties: id: type: string description: >- Identifier of the single- or multi-use mandate generated by the payment gateway. reason: type: string description: Reason for the mandate. state: type: string enum: - active - canceled - expired - agreed readOnly: true description: >- The status of the mandate, which indicates whether it can be used to initiate a payment. last_4: type: string readOnly: true description: The last four digits of the card number. example: '2042' paypal_express_native: type: object title: PaypalExpressNative description: >- If it is a `paypal_express_native` payment method, this hash contains details about the PayPal Express Native payment method. additionalProperties: false properties: baid: type: string description: >- Identifier of a PayPal billing agreement. For example, I-1TJ3GAGG82Y9. email: type: string description: >- Email address associated with the payment method. This is required with a paypal_express_checkout or a paypal_adaptive payment method. required: - baid paypal_express: type: object title: PaypalExpress description: >- If it is a `paypal_express` payment method, this hash contains details about the PayPal Express payment method. additionalProperties: false properties: baid: type: string description: >- Identifier of a PayPal billing agreement. For example, I-1TJ3GAGG82Y9. email: type: string description: Email address associated with the payment method required: - baid - email paypal_adaptive: type: object title: PaypalAdaptive description: >- If it is a `paypal_adaptive` payment method, this hash contains details about the PayPal Adaptive payment method. additionalProperties: false properties: preapproval_key: type: string description: PayPal preapproval key. example: 2G4EPFSD email: type: string description: Email address associated with the payment method. example: alawrence@zuora.com required: - preapproval_key - email sepa_debit: type: object title: SepaDebit description: >- If the `type` of the payment method is `sepa_debit`, this hash contains details about the SEPA bank account. additionalProperties: false properties: IBAN: type: string description: >- International Bank Account Number used to create the SEPA Debit payment method. mandate: type: object title: Mandate description: >- The mandate information for the Credit Card, Credit Card Reference Transaction, ACH, or Bank Transfer payment method. additionalProperties: false properties: id: type: string description: >- Identifier of the single- or multi-use mandate generated by the payment gateway. reason: type: string description: Reason for the mandate. state: type: string enum: - active - canceled - expired - agreed readOnly: true description: >- The status of the mandate, which indicates whether it can be used to initiate a payment. business_identification_code: type: string description: The BIC code used with the Sepa Debit payment method. required: - IBAN cc_ref: type: object title: CcRef description: >- If the `type` of the payment method is `cc_ref`, this hash contains details about the Credit Card Reference Transactions payment method. See [Supported payment methods](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/A_Supported_Payment_Methods) for payment gateways that support this type of payment method. additionalProperties: false properties: second_token: type: string description: >- A gateway unique identifier that replaces sensitive payment method data. This field is conditionally required only when `token` is being used to represent a gateway customer profile. token: type: string description: >- A gateway unique identifier that replaces sensitive payment method data or represents a gateway's unique customer profile. When `token` is used to represent a customer profile, `second_token` is conditionally required for representing the underlying tokenized payment method. mandate: type: object title: Mandate description: >- The mandate information for the Credit Card, Credit Card Reference Transaction, ACH, or Bank Transfer payment method. additionalProperties: false properties: id: type: string description: >- Identifier of the single- or multi-use mandate generated by the payment gateway. reason: type: string description: Reason for the mandate. state: type: string enum: - active - canceled - expired - agreed readOnly: true description: >- The status of the mandate, which indicates whether it can be used to initiate a payment. card: type: object title: CcRefCard description: '' nullable: false additionalProperties: false properties: brand: type: string enum: - visa - mastercard - american_express - discover - jcb - diners description: Card brand. expiry_month: type: number description: >- One or two digit expiration month (1-12) of the credit card. example: 10 expiry_year: type: number description: >- Two- or four-digit number representing the card's expiration year. example: 2024 last_4: type: string readOnly: true description: The last four digits of the card number. example: '2042' required: - token apple_pay: type: object title: ApplePay description: >- If the `type` of the payment method is `apple_pay`, this hash contains details about the Apple Pay payment method. See [Supported payment methods](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/A_Supported_Payment_Methods) for payment gateways that support this type of payment method. additionalProperties: false properties: card: allOf: - $ref: '#/components/schemas/getCardList' description: >- Credit card information. When providing a card number, you must meet the requirements for PCI compliance. We strongly recommend using Zuora.js instead of interacting with this API directly. mandate: type: object title: Mandate description: >- The mandate information for the Credit Card, Credit Card Reference Transaction, ACH, or Bank Transfer payment method. additionalProperties: false properties: id: type: string description: >- Identifier of the single- or multi-use mandate generated by the payment gateway. reason: type: string description: Reason for the mandate. state: type: string enum: - active - canceled - expired - agreed readOnly: true description: >- The status of the mandate, which indicates whether it can be used to initiate a payment. payment_id: type: string description: >- The ID of newly processed payment. Only available in the response of the Create Payment Method API request. token: type: string description: >- A gateway unique identifier that replaces sensitive payment method data or represents a gateway's unique customer profile. When `token` is used to represent a customer profile, `second_token` is conditionally required for representing the underlying tokenized payment method. google_pay: type: object title: GooglePay description: >- If the `type` of the payment method is `apple_pay`, this hash contains details about the Apple Pay payment method. See [Supported payment methods](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/A_Supported_Payment_Methods) for payment gateways that support this type of payment method. additionalProperties: false properties: card: allOf: - $ref: '#/components/schemas/getCardList' description: >- Credit card information. When providing a card number, you must meet the requirements for PCI compliance. We strongly recommend using Zuora.js instead of interacting with this API directly. token: type: string description: >- A gateway unique identifier that replaces sensitive payment method data or represents a gateway's unique customer profile. When `token` is used to represent a customer profile, `second_token` is conditionally required for representing the underlying tokenized payment method. ach_debit: type: object title: AchDebit description: >- If the `type` of the payment method is `ach_debit`, this hash contains details about the ACH bank account. additionalProperties: false properties: mandate: type: object title: Mandate description: >- The mandate information for the Credit Card, Credit Card Reference Transaction, ACH, or Bank Transfer payment method. additionalProperties: false properties: id: type: string description: >- Identifier of the single- or multi-use mandate generated by the payment gateway. reason: type: string description: Reason for the mandate. state: type: string enum: - active - canceled - expired - agreed readOnly: true description: >- The status of the mandate, which indicates whether it can be used to initiate a payment. bank_aba_code: type: string description: The nine-digit routing number or ABA number used by banks. bank_account_name: type: string description: >- The name of the account holder, which can be either a person or a company. bank_account_type: type: string enum: - business_saving - business_checking - checking - saving description: The type of bank account associated with the payment method. bank_name: type: string description: Name of the bank associated with this bank account. bank_account_number: type: string description: The bank account number of the account holder. required: - bank_aba_code - bank_account_type - bank_account_name - bank_account_number - bank_name betalings_debit: type: object title: BetalingsDebit description: >- If the `type` of the payment method is `betalings_debit`, this hash contains details about the Betalingsservice bank account. additionalProperties: false properties: account_number: type: string description: The bank account number of the account holder. identity_number: type: string description: >- The identity number used for Betalingsservice (Direct Debit DK). bank_code: type: string description: Identifier of the bank associated with this bank account. mandate: type: object title: Mandate description: >- The mandate information for the Credit Card, Credit Card Reference Transaction, ACH, or Bank Transfer payment method. additionalProperties: false properties: id: type: string description: >- Identifier of the single- or multi-use mandate generated by the payment gateway. reason: type: string description: Reason for the mandate. state: type: string enum: - active - canceled - expired - agreed readOnly: true description: >- The status of the mandate, which indicates whether it can be used to initiate a payment. required: - account_number - identity_number - bank_code autogiro_debit: type: object title: AutogiroDebit description: >- If the `type` of the payment method is `autogiro_debit`, this hash contains details about the Autogiro bank account. additionalProperties: false properties: account_number: type: string description: The bank account number of the account holder. identity_number: type: string description: The identity number used for Autogiro (Direct Debit SE). branch_code: type: string description: >- Identifier of the bank branch associated with this bank account. mandate: type: object title: Mandate description: >- The mandate information for the Credit Card, Credit Card Reference Transaction, ACH, or Bank Transfer payment method. additionalProperties: false properties: id: type: string description: >- Identifier of the single- or multi-use mandate generated by the payment gateway. reason: type: string description: Reason for the mandate. state: type: string enum: - active - canceled - expired - agreed readOnly: true description: >- The status of the mandate, which indicates whether it can be used to initiate a payment. required: - account_number - identity_number - branch_code bacs_debit: type: object title: BacsDebit description: >- If the `type` of the payment method is `bacs_debit`,, this hash contains details about the BACS bank account. additionalProperties: false properties: account_number: type: string description: The bank account number of the account holder. bank_code: type: string description: Identifier of the bank associated with this bank account. mandate: type: object title: Mandate description: >- The mandate information for the Credit Card, Credit Card Reference Transaction, ACH, or Bank Transfer payment method. additionalProperties: false properties: id: type: string description: >- Identifier of the single- or multi-use mandate generated by the payment gateway. reason: type: string description: Reason for the mandate. state: type: string enum: - active - canceled - expired - agreed readOnly: true description: >- The status of the mandate, which indicates whether it can be used to initiate a payment. required: - account_number - bank_code au_becs_debit: type: object title: AuBecsDebit description: >- If the `type` of the payment method is `au_becs_debit`, this hash contains details about the BECS bank account. additionalProperties: false properties: account_number: type: string description: The bank account number of the account holder. branch_code: type: string description: >- Identifier of the bank branch associated with this bank account. mandate: type: object title: Mandate description: >- The mandate information for the Credit Card, Credit Card Reference Transaction, ACH, or Bank Transfer payment method. additionalProperties: false properties: id: type: string description: >- Identifier of the single- or multi-use mandate generated by the payment gateway. reason: type: string description: Reason for the mandate. state: type: string enum: - active - canceled - expired - agreed readOnly: true description: >- The status of the mandate, which indicates whether it can be used to initiate a payment. required: - account_number - branch_code nz_becs_debit: type: object title: NzBecsDebit description: >- If the `type` of the payment method is `nz_becs_debit`, this hash contains details about the BECS-NZ bank account. additionalProperties: false properties: account_number: type: string description: The bank account number of the account holder. branch_code: type: string description: >- Identifier of the bank branch associated with this bank account. bank_code: type: string description: Identifier of the bank associated with this bank account. mandate: type: object title: Mandate description: >- The mandate information for the Credit Card, Credit Card Reference Transaction, ACH, or Bank Transfer payment method. additionalProperties: false properties: id: type: string description: >- Identifier of the single- or multi-use mandate generated by the payment gateway. reason: type: string description: Reason for the mandate. state: type: string enum: - active - canceled - expired - agreed readOnly: true description: >- The status of the mandate, which indicates whether it can be used to initiate a payment. required: - account_number - branch_code - bank_code pad_debit: type: object title: PadDebit description: >- If the `type` of the payment method is `pad_debit`, this hash contains details about the PAD bank account. additionalProperties: false properties: account_number: type: string description: The bank account number of the account holder. branch_code: type: string description: >- Identifier of the bank branch associated with this bank account. bank_code: type: string description: Identifier of the bank associated with this bank account. mandate: type: object title: Mandate description: >- The mandate information for the Credit Card, Credit Card Reference Transaction, ACH, or Bank Transfer payment method. additionalProperties: false properties: id: type: string description: >- Identifier of the single- or multi-use mandate generated by the payment gateway. reason: type: string description: Reason for the mandate. state: type: string enum: - active - canceled - expired - agreed readOnly: true description: >- The status of the mandate, which indicates whether it can be used to initiate a payment. required: - account_number - branch_code - bank_code state: type: string enum: - active - closed - scrubbed description: The state of the payment method. auto_generated: type: boolean use_default_retry_rule: type: boolean existing_mandate: type: boolean last_failed_sale_transaction_time: type: string format: date-time last_transaction_time: type: string format: date-time last_transaction_status: type: string number_of_consecutive_failures: type: integer total_number_of_processed_payments: type: integer total_number_of_error_payments: type: integer gateway_response: type: string description: Message returned by the payment gateway for this payment. gateway_reconciliation_status: type: string description: Gateway reconciliation state. gateway_reconciliation_reason: type: string description: Gateway reconciliation reason. gateway_state: type: string enum: - marked_for_submission - submitted - settled - not_submitted - failed readOnly: true description: The payment gateway state of the payment. applied_to: type: array items: $ref: '#/components/schemas/paymentsAppliedToResponse' readOnly: true payment_schedule_items: type: array items: $ref: '#/components/schemas/paymentScheduleItem' state_transitions: type: object title: PaymentStateTransitions description: The timestamps at which the object's state was updated. additionalProperties: false properties: canceled_time: type: string format: date-time description: >- The date and time (ISO 8601 UTC format) when the payment was canceled. gateway_state_transitions: type: object title: GatewayStateTransitions description: '' nullable: false additionalProperties: false properties: marked_for_submission_time: type: string format: date-time readOnly: true description: >- The date and time (ISO 8601 UTC format) when the payment was marked for submission. settled_time: type: string format: date-time description: >- The date and time (ISO 8601 UTC format) when the payment was settled. submitted_time: type: string format: date-time description: >- The date and time (ISO 8601 UTC format) when the payment was submitted. paymentsAppliedToResponse: type: object title: PaymentsAppliedToResponse description: '' nullable: false additionalProperties: false properties: billing_document_id: type: string description: Identifier of an invoice or a debit memo. id: type: string description: Identifier of the payment application. amount: type: number description: >- The amount of the payment that is applied to the specific billing document item or taxation item. billing_document: allOf: - $ref: '#/components/schemas/billingDocument' description: The related billing document. billing_document_type: type: string enum: - debit_memo - invoice description: >- The type of billing document. Can be one of the debit memo or invoice. state: type: string enum: - draft - posted - processing - processed - error - canceled readOnly: true items: type: array items: $ref: '#/components/schemas/paymentAppliedToBillingItemResponse' description: The related billing document item. paymentApplyUnapplyRequest: type: object title: PaymentApplyUnapplyRequest description: '' additionalProperties: false properties: effective_date: type: string format: date description: The date and time when the payment takes effect. billing_documents: type: array items: $ref: '#/components/schemas/billingDocumentPaymentApplicationRequest' description: >- Indicates to which billing documents (invoices or debit memos) are the payment applied. required: - billing_documents paymentListResponse: type: object title: PaymentListResponse description: '' nullable: false additionalProperties: false properties: next_page: type: string nullable: true data: type: array items: $ref: '#/components/schemas/payment' paymentAppliedToBillingItemResponse: type: object title: PaymentAppliedToBillingItemResponse description: '' nullable: false additionalProperties: false properties: billing_document_item_id: type: string description: Identifier of an invoice or a debit memo item. id: type: string description: Identifier of the payment application item. billing_document_item: allOf: - $ref: '#/components/schemas/billingDocumentItem' description: The related billing document item. amount: type: number description: >- The amount of the payment that is applied to the specific billing document item. billing_document_id: type: string description: Identifier of an invoice or a debit memo. taxation_item_id: type: string description: Identifier of a taxation item. writeOffSuscriptionRequest: type: object title: WriteOffSuscriptionRequest description: >- The financial information of the credit memo items generated to write off the invoice balance. additionalProperties: false properties: on_account_accounting_code: type: string description: An active accounting code in your Zuora chart of accounts. deferred_revenue_accounting_code: type: string description: An active accounting code in your Zuora chart of accounts. recognized_revenue_accounting_code: type: string description: An active accounting code in your Zuora chart of accounts. revenue_recognition_rule_name: type: string description: Name of the revenue recognition rule that you want to apply. processingOptions: type: object title: ProcessingOptions description: Processing options for the invoice or payment. additionalProperties: false properties: document_date: type: string format: date description: The date printed on billing documents. target_date: type: string format: date description: >- The target date for the order to be picked up by bill run for billing. collection_method: type: string enum: - collect_payment - create_invoice - process_refund - run_billing description: >- Specifies whether to just create an invoice, or to create an invoice and collect payment. payment_method_id: type: string description: Payment method Id used to pay billing documents. draft_invoice: type: boolean payment_gateway_id: type: string refund_reason_code: type: string term: type: object title: Term description: Term information of the subscription. additionalProperties: false properties: interval_count: type: integer minimum: 1 description: >- The number of intervals in a term. For example, interval=year and interval_count=1 represents a 1 year term. interval: type: string enum: - day - week - month - year description: >- Unit in which term duration is defined. One of day, week, month or year. start_date: type: string format: date description: Date when the subscription term starts. example: '2020-01-01' type: type: string enum: - evergreen - termed description: Type of the subscription. Can be either `termed` or `evergreen`. end_date: type: string format: date description: Date when the subscription term ends. example: '2023-01-01' startOnResponse: type: object title: StartOnResponse description: Indicates on which date the subscription becomes effective. additionalProperties: false properties: contract_effective: type: string format: date description: >- Effective contract date for this subscription, in the `yyyy-mm-dd` format. example: '2022-06-01' service_activation: type: string format: date description: >- The date on which the services or products within a subscription have been activated and access has been provided to the customer, as the `yyyy-mm-dd` format. example: '2022-06-01' customer_acceptance: type: string format: date description: >- The date on which the services or products within a subscription have been accepted by the customer, in the `yyyy-mm-dd` format. example: '2022-06-01' startOn: type: object title: StartOn description: Indicates on which date the subscription becomes effective. additionalProperties: false properties: contract_effective: type: string format: date description: >- Effective contract date for this subscription, in the `yyyy-mm-dd` format. example: '2022-06-01' service_activation: type: string format: date description: >- The date on which the services or products within a subscription have been activated and access has been provided to the customer, as the `yyyy-mm-dd` format. example: '2022-06-01' customer_acceptance: type: string format: date description: >- The date on which the services or products within a subscription have been accepted by the customer, in the `yyyy-mm-dd` format. example: '2022-06-01' required: - contract_effective subscriptionTermPatchRequest: type: object title: SubscriptionTermPatchRequest description: Term information of the subscription. additionalProperties: false properties: current_term: allOf: - $ref: '#/components/schemas/term' description: Current term information for the subscription. renewal_term: allOf: - $ref: '#/components/schemas/term' description: Renewal term information for the subscription. auto_renew: type: boolean description: >- If true, the subscription automatically renews at the end of the current term. start_on: $ref: '#/components/schemas/startOn' bill_to_id: type: string nullable: true x-extra-field-annotation: '@JsonAdapter(NullableFieldAdapter.class)' description: ID of the bill-to contact. example: 2c92c0f86a8dd422016a9e7a70116b0d payment_terms: type: string nullable: true x-extra-field-annotation: '@JsonAdapter(NullableFieldAdapter.class)' description: The name of payment term associated with the invoice. billing_document_settings: allOf: - $ref: '#/components/schemas/flexibleBillingDocumentSettings' description: The billing document settings for the customer. sold_to_id: type: string nullable: true x-extra-field-annotation: '@JsonAdapter(NullableFieldAdapter.class)' description: ID of the sold-to contact. example: 2c92c0f86a8dd422016a9e7a70116b0d subscriptionRemovePlanPatchRequest: type: object title: SubscriptionRemovePlanPatchRequest description: '' nullable: false additionalProperties: false properties: subscription_plan_id: type: string description: Identifier of the subscription plan. start_on: $ref: '#/components/schemas/startOn' unique_token: type: string description: >- Unique identifier for the subscription plan. This identifier enables you to refer to the subscription plan before the subscription plan has an internal identifier in Zuora. subscriptionRenewPatchRequest: type: object title: SubscriptionRenewPatchRequest description: Specify this field when renewing a subscription. additionalProperties: false properties: start_on: $ref: '#/components/schemas/startOn' subscriptionAddPlanPatchRequest: type: object title: SubscriptionAddPlanPatchRequest description: '' additionalProperties: false properties: subscription_plan: $ref: '#/components/schemas/subscriptionPlanCreateRequest' start_on: $ref: '#/components/schemas/startOn' required: - subscription_plan subscriptionUpdatePlanPatchRequest: type: object title: SubscriptionUpdatePlanPatchRequest description: '' additionalProperties: false properties: subscription_plan: $ref: '#/components/schemas/subscriptionPlanPatchRequest' start_on: $ref: '#/components/schemas/startOn' start_date: type: string format: date description: The start date from which this order action becomes effective. example: '2022-01-01' required: - subscription_plan subscriptionReplacePlanPatchRequest: type: object title: SubscriptionReplacePlanPatchRequest description: '' additionalProperties: false properties: subscription_plan_id: type: string description: Identifier of the subscription plan. previous_plan_id: type: string description: Identifier of the plan to be removed. replace_at: type: string enum: - now - end_of_billing_period - specific_date replacement_type: type: string enum: - upgrade - downgrade - crossgrade - other subscription_plan: $ref: '#/components/schemas/subscriptionPlanCreateRequest' start_on: $ref: '#/components/schemas/startOn' required: - subscription_plan_id - subscription_plan pauseSubscriptionRequest: type: object title: PauseSubscriptionRequest description: '' nullable: true additionalProperties: false properties: pause_date: type: string x-zuora-field-type: date description: Date on which the subscription is paused. pause_at: type: string enum: - invoice_period_end description: >- Can be either the end of the current billing period or a specific date. pause_interval_count: type: number description: >- The number of intervals in a duration where the subscription is paused. For example, pause_interval=year and pause_interval_count=1 represents a 1-year pause. pause_interval: type: string enum: - month - day - year - week description: >- Unit in which the pause duration is defined. One of day, week, month or year. resume_behavior: $ref: '#/components/schemas/resumeSubscriptionRequest' custom_fields: $ref: '#/components/schemas/customFields' resumeSubscriptionRequest: type: object title: ResumeSubscriptionRequest description: Behavior of the paused subscription when it resumes. additionalProperties: false properties: extend_term: type: boolean default: false description: >- If this field is set to `true`, the subscription term is extended by the length of time the subscription is paused. resume_date: type: string x-zuora-field-type: date description: Date on which the paused subscription is resumed. resume_at: type: string enum: - pause_date description: >- You can use this field to resume a paused subscription from the pause date. custom_fields: $ref: '#/components/schemas/customFields' cancelSubscriptionRequest: type: object title: CancelSubscriptionRequest description: '' nullable: false additionalProperties: false properties: cancel_date: type: string x-zuora-field-type: date description: Date on which the subscription is canceled. cancel_at: type: string enum: - invoice_period_end - subscription_term_end description: >- The date on which the subscription is canceled. Can be either the end of the subscription term or the end of the billing period. processing_options: allOf: - $ref: '#/components/schemas/processingOptions' description: Processing options for the invoice or payment. refund_amount: type: number description: Amount to be refunded write_off: type: boolean default: false description: >- Indicates whether to write off the outstanding balance on the invoice after canceling the subscription. write_off_behavior: $ref: '#/components/schemas/writeOffSuscriptionRequest' custom_fields: $ref: '#/components/schemas/customFields' subscriptionCreateRequest: type: object title: SubscriptionCreateRequest description: '' nullable: false additionalProperties: false properties: invoice_owner_account_id: type: string description: >- Identifier of the account that owns the invoice associated with this subscription. If you specify this field, do not specify `invoice_owner_account_data`. invoice_owner_account_number: type: string description: >- Identifier of the account that owns the invoice associated with this subscription. If you specify this field, do not specify `invoice_owner_account_data`. invoice_owner_account_data: allOf: - $ref: '#/components/schemas/accountCreateRequest' description: >- The information of the new account that owns the invoice associated with this subscription. If you specify this field, do not specify `invoice_owner_account_id`. account_id: type: string description: >- Identifier of the account that owns the subscription. Subscription owner account can be different from the invoice owner account. If you specify this field, do not specify `account_data`. account_number: type: string description: >- Identifier of the account that owns the subscription. Subscription owner account can be different from the invoice owner account. If you specify this field, do not specify `account_data`. account_data: allOf: - $ref: '#/components/schemas/accountCreateRequest' description: >- The information of the new account that owns the subscription. The subscription owner account can be different from the invoice owner account. If you specify this field, do not specify `account_id`. auto_renew: type: boolean description: >- If true, the subscription automatically renews at the end of the current term. subscription_number: type: string description: Human-readable identifier of the subscription; maybe user-supplied. initial_term: allOf: - $ref: '#/components/schemas/term' description: Initial term information for the subscription. renewal_term: allOf: - $ref: '#/components/schemas/term' description: Renewal term information for the subscription start_on: $ref: '#/components/schemas/startOn' description: type: string description: >- Description of the subscription. Often useful for displaying to users. invoice_separately: type: boolean description: >- Separates a single subscription from other subscriptions and creates an invoice for this subscription. If the value is `true`, the subscription is billed separately from other subscriptions. If the value is `false`, the subscription is included with other subscriptions in the account invoice. processing_options: $ref: '#/components/schemas/processingOptions' custom_fields: $ref: '#/components/schemas/customFields' subscription_plans: type: array items: $ref: '#/components/schemas/subscriptionPlanCreateRequest' description: The plans associated with the new subscription. bill_to_id: type: string nullable: true x-extra-field-annotation: '@JsonAdapter(NullableFieldAdapter.class)' description: ID of the bill-to contact. example: 2c92c0f86a8dd422016a9e7a70116b0d payment_terms: type: string nullable: true x-extra-field-annotation: '@JsonAdapter(NullableFieldAdapter.class)' description: The name of payment term associated with the invoice. bill_to: allOf: - $ref: '#/components/schemas/contact' readOnly: true description: The billing address for the customer. billing_document_settings: allOf: - $ref: '#/components/schemas/flexibleBillingDocumentSettings' description: The billing document settings for the customer. sold_to_id: type: string nullable: true x-extra-field-annotation: '@JsonAdapter(NullableFieldAdapter.class)' description: ID of the sold-to contact. example: 2c92c0f86a8dd422016a9e7a70116b0d sold_to: allOf: - $ref: '#/components/schemas/contact' readOnly: true description: The selling address for the customer. subscription: type: object title: Subscription description: Subscription information. additionalProperties: false properties: id: type: string readOnly: true description: Unique identifier for the object. updated_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who last updated the object updated_time: type: string format: date-time readOnly: true description: >- The date and time when the object was last updated in ISO 8601 UTC format. created_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who created the object created_time: type: string format: date-time readOnly: true description: >- The date and time when the object was created in ISO 8601 UTC format. custom_fields: type: object title: CustomFields description: >- Set of user-defined fields associated with this object. Useful for storing additional information about the object in a structured format. x-extra-field-annotation: '@JsonAdapter(CustomFieldAdapter.class)' additionalProperties: true custom_objects: oneOf: - $ref: '#/components/schemas/listCustomObjectResponse' - $ref: '#/components/schemas/custom_object' readOnly: true description: The custom objects associated with a Zuora standard object. subscription_number: type: string description: >- Human-readable identifier of the subscription. It can be user-supplied. state: type: string enum: - draft - pending_activation - pending_acceptance - active - expired - canceled - paused description: Status of the subscription. version: type: integer description: >- The version of the subscription. This version can be used in the `filter[]` query parameter to filter subscriptions. account_id: type: string description: Identifier of the account associated with this subscription. account: allOf: - $ref: '#/components/schemas/account' description: Information of the new account associated with the subscription. invoice_owner_account_id: type: string description: >- Identifier of the account that owns the invoice associated with this subscription. invoice_owner_account: allOf: - $ref: '#/components/schemas/account' description: Identifier of the account that owns the subscription. auto_renew: type: boolean description: >- If this field is set to `true`, the subscription automatically renews at the end of the current term. latest_version: type: boolean description: If true, this is the latest version of the subscription initial_term: allOf: - $ref: '#/components/schemas/term' description: Initial term information for the subscription. current_term: allOf: - $ref: '#/components/schemas/term' description: Current term information for the subscription renewal_term: allOf: - $ref: '#/components/schemas/term' description: Renewal term information for the subscription. start_date: type: string format: date description: Date when the subscription starts. example: '2020-01-01' end_date: type: string format: date description: Date when the subscription ends. example: '2023-01-01' description: type: string description: >- Description of the subscription. Often useful for displaying to users. contract_effective: type: string format: date description: Date when the subscriber contract is effective. example: '2023-01-01' service_activation: type: string format: date description: Date when the subscribed-to service is activated. example: '2023-01-01' customer_acceptance: type: string format: date description: >- Date when all the services or products in the subscription are accepted by the subscriber. example: '2023-01-01' invoice_separately: type: boolean description: >- If true, the subscription is billed separately from other subscriptions. If false, the subscription is included with other subscriptions in the account invoice. The default is false. order_number: type: string description: The order number of the order created by Zuora. subscription_plans: allOf: - $ref: '#/components/schemas/subscriptionPlanListResponse' readOnly: true description: List of subscription plans. invoice_items: allOf: - $ref: '#/components/schemas/invoiceItemListResponse' readOnly: true description: List of invoice items. prepaid_balance: type: array items: $ref: '#/components/schemas/prepaidBalance' readOnly: true description: >- Total prepaid units available during a subscription. It is an aggregate of all funds under a subscription. contracted_mrr: type: string description: Monthly recurring revenue of the subscription. bill_to_id: type: string nullable: true x-extra-field-annotation: '@JsonAdapter(NullableFieldAdapter.class)' description: ID of the bill-to contact. example: 2c92c0f86a8dd422016a9e7a70116b0d payment_terms: type: string nullable: true x-extra-field-annotation: '@JsonAdapter(NullableFieldAdapter.class)' description: The name of payment term associated with the invoice. bill_to: allOf: - $ref: '#/components/schemas/contact' readOnly: true description: The billing address for the customer. billing_document_settings: allOf: - $ref: '#/components/schemas/flexibleBillingDocumentSettings' description: The billing document settings for the customer. sold_to_id: type: string nullable: true x-extra-field-annotation: '@JsonAdapter(NullableFieldAdapter.class)' description: ID of the sold-to contact. example: 2c92c0f86a8dd422016a9e7a70116b0d sold_to: allOf: - $ref: '#/components/schemas/contact' readOnly: true description: The selling address for the customer. subscriptionPatchRequest: type: object title: SubscriptionPatchRequest description: '' nullable: true additionalProperties: false properties: description: type: string description: Description of the subscription. custom_fields: $ref: '#/components/schemas/customFields' terms: $ref: '#/components/schemas/subscriptionTermPatchRequest' start_on: $ref: '#/components/schemas/startOn' invoice_owner_account_id: type: string description: >- Identifier of the account that owns the invoice associated with this subscription. invoice_owner_account_number: type: string description: >- Identifier of the account that owns the invoice associated with this subscription. account_id: type: string description: >- Identifier of the account that owns the subscription. Subscription owner account can be different from the invoice owner account. account_number: type: string description: >- Identifier of the account that owns the subscription. Subscription owner account can be different from the invoice owner account. add_subscription_plans: type: array items: $ref: '#/components/schemas/subscriptionAddPlanPatchRequest' description: >- Specify this field if you want to add one or multiple subscription plans to this subscription. remove_subscription_plans: type: array items: $ref: '#/components/schemas/subscriptionRemovePlanPatchRequest' description: >- Specify this field if you want to remove one or multiple subscription plans from this subscription. replace_subscription_plans: type: array items: $ref: '#/components/schemas/subscriptionReplacePlanPatchRequest' description: >- Specify this field if you want to replace one or multiple subscription plans to this subscription.
**Note**: This field is currently not supported if you have Billing - Revenue Integration enabled. When Billing - Revenue Integration is enabled, the replace subscription plan type of order action will no longer be applicable in Zuora Billing. update_subscription_plans: type: array items: $ref: '#/components/schemas/subscriptionUpdatePlanPatchRequest' renew: $ref: '#/components/schemas/subscriptionRenewPatchRequest' renewals: type: array items: $ref: '#/components/schemas/subscriptionRenewPatchRequest' description: Specify this field when renewing a subscription. cancel: $ref: '#/components/schemas/cancelSubscriptionRequest' pause: $ref: '#/components/schemas/pauseSubscriptionRequest' resume: $ref: '#/components/schemas/resumeSubscriptionRequest' bill_to_id: type: string nullable: true x-extra-field-annotation: '@JsonAdapter(NullableFieldAdapter.class)' description: ID of the bill-to contact. example: 2c92c0f86a8dd422016a9e7a70116b0d payment_terms: type: string nullable: true x-extra-field-annotation: '@JsonAdapter(NullableFieldAdapter.class)' description: The name of payment term associated with the invoice. billing_document_settings: allOf: - $ref: '#/components/schemas/flexibleBillingDocumentSettings' description: The billing document settings for the customer. sold_to_id: type: string nullable: true x-extra-field-annotation: '@JsonAdapter(NullableFieldAdapter.class)' description: ID of the sold-to contact. example: 2c92c0f86a8dd422016a9e7a70116b0d invoice_separately: type: boolean description: >- Separates a single subscription from other subscriptions and creates an invoice for this subscription. If the value is `true`, the subscription is billed separately from other subscriptions. If the value is `false`, the subscription is included with other subscriptions in the account invoice. subscriptionActivateRequest: type: object title: SubscriptionActivateRequest description: '' nullable: true additionalProperties: false properties: contract_effective: type: string format: date description: >- Effective contract date for this subscription, in the `yyyy-mm-dd` format. example: '2022-06-01' service_activation: type: string format: date description: >- The date on which the services or products within a subscription have been activated and access has been provided to the customer, as the `yyyy-mm-dd` format. example: '2022-06-01' customer_acceptance: type: string format: date description: >- The date on which the services or products within a subscription have been accepted by the customer, in the `yyyy-mm-dd` format. example: '2022-06-01' subscriptionListResponse: type: object title: SubscriptionListResponse description: '' nullable: false additionalProperties: false properties: next_page: type: string nullable: true data: type: array items: $ref: '#/components/schemas/subscription' postSubscriptionOrderRequest: type: object title: PostSubscriptionOrderRequest description: '' nullable: false additionalProperties: false properties: account_number: type: string description: >- Identifier of the account that owns the subscription. Subscription owner account can be different from the invoice owner account. If you specify this field, do not specify `account_data`. account_id: type: string description: >- Identifier of the account that owns the subscription. Subscription owner account can be different from the invoice owner account. If you specify this field, do not specify `account_data`. account_data: allOf: - $ref: '#/components/schemas/accountCreateRequest' description: >- The information of the new account that owns the subscription. The subscription owner account can be different from the invoice owner account. If you specify this field, do not specify `account_id`. invoice_owner_account_number: type: string description: >- Identifier of the account that owns the invoice associated with this subscription. If you specify this field, do not specify `invoice_owner_account_data`. auto_renew: type: boolean description: >- If true, the subscription automatically renews at the end of the current term. subscription_number: type: string description: Human-readable identifier of the subscription; maybe user-supplied. initial_term: allOf: - $ref: '#/components/schemas/term' description: Initial term information for the subscription. renewal_term: allOf: - $ref: '#/components/schemas/term' description: Renewal term information for the subscription start_on: $ref: '#/components/schemas/startOn' description: type: string description: >- Description of the subscription. Often useful for displaying to users. invoice_separately: type: boolean description: >- Separates a single subscription from other subscriptions and creates an invoice for this subscription. If the value is `true`, the subscription is billed separately from other subscriptions. If the value is `false`, the subscription is included with other subscriptions in the account invoice. processing_options: $ref: '#/components/schemas/processingOptions' custom_fields: $ref: '#/components/schemas/customFields' subscription_plans: type: array items: $ref: '#/components/schemas/subscriptionPlanCreateRequest' description: The plans associated with the new subscription. add_subscription_plans: type: array items: $ref: '#/components/schemas/subscriptionAddPlanPatchRequest' description: >- Specify this field if you want to add one or multiple subscription plans to this subscription. remove_subscription_plans: type: array items: $ref: '#/components/schemas/subscriptionRemovePlanPatchRequest' description: >- Specify this field if you want to remove one or multiple subscription plans from this subscription. update_subscription_plans: type: array items: $ref: '#/components/schemas/subscriptionUpdatePlanPatchRequest' renew: $ref: '#/components/schemas/subscriptionRenewPatchRequest' renewals: type: array items: $ref: '#/components/schemas/subscriptionRenewPatchRequest' description: Specify this field when renewing a subscription. cancel: $ref: '#/components/schemas/cancelSubscriptionRequest' pause: $ref: '#/components/schemas/pauseSubscriptionRequest' resume: $ref: '#/components/schemas/resumeSubscriptionRequest' replace_subscription_plans: type: array items: $ref: '#/components/schemas/subscriptionReplacePlanPatchRequest' description: >- Specify this field if you want to replace one or multiple subscription plans to this subscription.
**Note**: This field is currently not supported if you have Billing - Revenue Integration enabled. When Billing - Revenue Integration is enabled, the replace subscription plan type of order action will no longer be applicable in Zuora Billing. terms: $ref: '#/components/schemas/subscriptionTermPatchRequest' bill_to_id: type: string nullable: true x-extra-field-annotation: '@JsonAdapter(NullableFieldAdapter.class)' description: ID of the bill-to contact. example: 2c92c0f86a8dd422016a9e7a70116b0d sold_to_id: type: string nullable: true x-extra-field-annotation: '@JsonAdapter(NullableFieldAdapter.class)' description: ID of the sold-to contact. example: 2c92c0f86a8dd422016a9e7a70116b0d payment_terms: type: string nullable: true x-extra-field-annotation: '@JsonAdapter(NullableFieldAdapter.class)' description: The name of payment term associated with the invoice. billing_document_settings: allOf: - $ref: '#/components/schemas/flexibleBillingDocumentSettings' description: The billing document settings for the customer. subscriptionPreviewAccountRequest: type: object title: SubscriptionPreviewAccountRequest description: >- Account data that is used for the subscription preview. If you specify this field, do not specify `account_id`. Note that this operation is only for preview and no subscription is created. additionalProperties: false properties: sold_to: allOf: - $ref: '#/components/schemas/accountContactCreateRequest' description: Customer address used for calculating tax. tax_certificate: $ref: '#/components/schemas/taxCertificate' bill_cycle_day: type: integer minimum: 0 maximum: 31 description: >- The day of the month on which your customer will be invoiced. For month-end specify 31. currency: type: string description: >- Three-letter ISO currency code. Once the currency is set for an account, it cannot be updated. example: USD tax_identifier: $ref: '#/components/schemas/taxIdentifier' custom_fields: $ref: '#/components/schemas/customFields' required: - bill_cycle_day - currency subscriptionPreviewRequest: type: object title: SubscriptionPreviewRequest description: '' nullable: false additionalProperties: false properties: invoice_owner_account_id: type: string description: >- Identifier of the account that owns the invoice associated with this subscription. If you specify this field, do not specify `invoice_owner_account_data`. invoice_owner_account_number: type: string description: >- Identifier of the account that owns the invoice associated with this subscription. If you specify this field, do not specify `invoice_owner_account_data`. invoice_owner_account_data: allOf: - $ref: '#/components/schemas/accountCreateRequest' description: >- The information of the new account that owns the invoice associated with this subscription. If you specify this field, do not specify `invoice_owner_account_id`. account_id: type: string description: >- Identifier of the account that owns the subscription. Subscription owner account can be different from the invoice owner account. If you specify this field, do not specify `account_data`. account_number: type: string description: >- Identifier of the account that owns the subscription. Subscription owner account can be different from the invoice owner account. If you specify this field, do not specify `account_data`. account_data: $ref: '#/components/schemas/subscriptionPreviewAccountRequest' auto_renew: type: boolean description: >- If true, the subscription automatically renews at the end of the current term. subscription_number: type: string description: Human-readable identifier of the subscription; maybe user-supplied. initial_term: allOf: - $ref: '#/components/schemas/term' description: Initial term information for the subscription. renewal_term: allOf: - $ref: '#/components/schemas/term' description: Renewal term information for the subscription start_on: $ref: '#/components/schemas/startOn' description: type: string description: >- Description of the subscription. Often useful for displaying to users. invoice_separately: type: boolean description: >- Separates a single subscription from other subscriptions and creates an invoice for this subscription. If the value is `true`, the subscription is billed separately from other subscriptions. If the value is `false`, the subscription is included with other subscriptions in the account invoice. processing_options: $ref: '#/components/schemas/processingOptions' custom_fields: $ref: '#/components/schemas/customFields' subscription_plans: type: array items: $ref: '#/components/schemas/subscriptionPlanCreateRequest' description: The plans associated with the new subscription. bill_to_id: type: string nullable: true x-extra-field-annotation: '@JsonAdapter(NullableFieldAdapter.class)' description: ID of the bill-to contact. example: 2c92c0f86a8dd422016a9e7a70116b0d payment_terms: type: string nullable: true x-extra-field-annotation: '@JsonAdapter(NullableFieldAdapter.class)' description: The name of payment term associated with the invoice. bill_to: allOf: - $ref: '#/components/schemas/contact' readOnly: true description: The billing address for the customer. billing_document_settings: allOf: - $ref: '#/components/schemas/flexibleBillingDocumentSettings' description: The billing document settings for the customer. sold_to_id: type: string nullable: true x-extra-field-annotation: '@JsonAdapter(NullableFieldAdapter.class)' description: ID of the sold-to contact. example: 2c92c0f86a8dd422016a9e7a70116b0d sold_to: allOf: - $ref: '#/components/schemas/contact' readOnly: true description: The selling address for the customer. number_of_periods: type: integer description: Specifies how many billing periods you want to preview. term_end: type: boolean description: >- Indicates whether to preview the subscription till the end of the current term. metrics: type: array items: type: string enum: - billing_documents - delta_metrics description: >- Specifies the metrics you want to preview. You can preivew metrics of billing documents, the order delta metrics, or both. end_date: type: string format: date description: >- End date of the period for which you want to preview the subscription subscriptionItemPreviewResponse: type: object title: SubscriptionItemPreviewResponse description: '' nullable: false additionalProperties: false properties: subscription_item_id: type: string description: Identifier of the subscription item. price_id: type: string description: Identifier of the price. start_date: type: string format: date description: Date on which the subscription item starts to become effective. end_date: type: string format: date description: Date on which the subscription item expires. mrr: type: object properties: gross_amount: type: number net_amount: type: number currency: type: string tcb: type: object properties: gross_amount: type: number net_amount: type: number currency: type: string tcv: type: object properties: gross_amount: type: number net_amount: type: number currency: type: string subscriptionPreviewActionsResponse: type: object title: SubscriptionPreviewActionsResponse description: '' nullable: false additionalProperties: false properties: action_id: type: string description: Identifier of the action. action: type: string enum: - create_subscription - terms - add_subscription_plan - update_subscription_plan - remove_subscription_plan - renew - cancel - owner_transfer - pause - resume - replace_subscription_plan description: The action associated with this metric. sequence: type: integer description: The sequence number of the action. subscription_items: type: array items: allOf: - $ref: '#/components/schemas/subscriptionItemPreviewResponse' subscriptionPreviewResponse: type: object title: SubscriptionPreviewResponse description: '' nullable: false additionalProperties: false properties: actions: type: array items: allOf: - $ref: '#/components/schemas/subscriptionPreviewActionsResponse' billing_documents: type: array items: allOf: - $ref: >- #/components/schemas/subscriptionPreviewBillingDocumentsResponse subscriptionPreviewBillingDocumentItemResponse: type: object title: SubscriptionPreviewBillingDocumentItemResponse description: '' nullable: false additionalProperties: false properties: subscription_item_description: type: string subscription_item_name: type: string subscription_item_number: type: string processing_type: type: string enum: - subscription_item - discount - prepayment - tax product_name: type: string price_id: type: string description: >- The identifier of the price this billing document item is associated with. service_end_date: type: string description: >- The end date of the service period associated with this billing document item. If the associated charge is a one-time fee, then this date is the date of that charge. service_start_date: type: string description: >- The start date of the service period associated with this billing document item. If the associated charge is a one-time fee, then this date is the date of that charge. tax: type: number description: The amount of tax applied to the billing document item. quantity: type: number description: The number of units of this item. unit_of_measure: type: string description: Specifies the units used to measure usage. subtotal: type: number description: The total amount of this billing document item exclusive of tax. total: type: number description: The total amount of this billing document item. taxation_items: type: array items: allOf: - $ref: >- #/components/schemas/subscriptionPreviewBillingDocumentTaxationItemResponse subscriptionPreviewBillingDocumentTaxationItemResponse: type: object title: SubscriptionPreviewBillingDocumentTaxationItemResponse description: '' nullable: false additionalProperties: false properties: amount_exempt: type: number description: The calculated tax amount excluded due to the exemption. id: type: string description: >- Identifier of the taxation item related to the invoice. Only applicable for credit memos created from invoices. jurisdiction: type: string maxLength: 32 description: >- The jurisdiction that applies the tax or VAT. This value is typically a state, province, county, or city. location_code: type: string maxLength: 32 description: >- The identifier for the location based on the value of the `tax_code` field. name: type: string maxLength: 128 description: The name of the taxation item. amount: type: number description: The amount of the tax applied to the total price. tax_code: type: string description: >- A tax code identifier. If a `tax_code` of a price is not provided when you create or update a price, Zuora will treat the charged amount as non-taxable. If this code is provide, Zuora considers that this price is taxable and the charged amount will be handled accordingly. tax_code_name: type: string description: The amount of the tax applied to the total price. date: type: string format: date description: The date on which the tax is applied. example: '2022-01-01' tax_rate: type: number description: The amount of the tax applied to the total price. tax_rate_name: type: string description: >- The name of the tax rate, such as sales tax or GST. This name is displayed on billing documents. tax_rate_type: type: string enum: - percent - amount description: Indicates whether the tax rate is an amount or a percentage. subscriptionPreviewBillingDocumentsResponse: type: object title: SubscriptionPreviewBillingDocumentsResponse description: '' nullable: false additionalProperties: false properties: subtotal: type: number readOnly: true description: The total amount exclusive of tax. tax: type: number readOnly: true description: The total tax amount. total: type: number readOnly: true description: The total amount. type: type: string enum: - credit_memo - debit_memo - invoice description: >- The type of billing document. Can be one of the credit memo, debit memo, or invoice. target_date: type: string format: date billing_document_items: type: array items: allOf: - $ref: >- #/components/schemas/subscriptionPreviewBillingDocumentItemResponse subscriptionPreviewExistingRequest: type: object title: SubscriptionPreviewExistingRequest description: '' nullable: false additionalProperties: false properties: custom_fields: $ref: '#/components/schemas/customFields' description: type: string description: Description of the subscription. account_id: type: string description: >- Identifier of the account that owns the subscription. Subscription owner account can be different from the invoice owner account. account_number: type: string description: >- Identifier of the account that owns the subscription. Subscription owner account can be different from the invoice owner account. account_data: $ref: '#/components/schemas/subscriptionPreviewAccountRequest' number_of_periods: type: integer description: Specifies how many billing periods you want to preview. term_end: type: boolean description: >- Indicates whether to preview the subscription till the end of the current term. metrics: type: array items: type: string enum: - billing_documents - delta_metrics description: >- Specifies the metrics you want to preview. You can preview metrics of billing documents, the order delta metrics, or both. end_date: type: string format: date description: >- End date of the period for which you want to preview the subscription add_subscription_plans: type: array items: $ref: '#/components/schemas/subscriptionAddPlanPatchRequest' description: >- Specify this field if you want to add one or multiple subscription plans to this subscription. replace_subscription_plans: type: array items: $ref: '#/components/schemas/subscriptionReplacePlanPatchRequest' description: >- Specify this field if you want to replace one or multiple subscription plans to this subscription.
**Note**: This field is currently not supported if you have Billing - Revenue Integration enabled. When Billing - Revenue Integration is enabled, the replace subscription plan type of order action will no longer be applicable in Zuora Billing. update_subscription_plans: type: array items: $ref: '#/components/schemas/subscriptionUpdatePlanPatchRequest' remove_subscription_plans: type: array items: $ref: '#/components/schemas/subscriptionRemovePlanPatchRequest' description: >- Specify this field if you want to remove one or multiple subscription plans from this subscription. orderActionListResponse: type: object title: OrderActionListResponse description: '' nullable: false additionalProperties: false properties: next_page: type: string nullable: true data: type: array items: $ref: '#/components/schemas/orderAction' subscriptionVersion: type: object title: SubscriptionVersion description: '' nullable: false additionalProperties: false properties: id: type: string readOnly: true description: Unique identifier for the object. updated_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who last updated the object updated_time: type: string format: date-time readOnly: true description: >- The date and time when the object was last updated in ISO 8601 UTC format. created_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who created the object created_time: type: string format: date-time readOnly: true description: >- The date and time when the object was created in ISO 8601 UTC format. custom_fields: type: object title: CustomFields description: >- Set of user-defined fields associated with this object. Useful for storing additional information about the object in a structured format. x-extra-field-annotation: '@JsonAdapter(CustomFieldAdapter.class)' additionalProperties: true custom_objects: oneOf: - $ref: '#/components/schemas/listCustomObjectResponse' - $ref: '#/components/schemas/custom_object' readOnly: true description: The custom objects associated with a Zuora standard object. subscription_number: type: string description: >- Human-readable identifier of the subscription. It can be user-supplied. state: type: string enum: - draft - pending_activation - pending_acceptance - active - expired - canceled - paused description: Status of the subscription. version: type: integer description: >- The version of the subscription. This version can be used in the `filter[]` query parameter to filter subscriptions. account_id: type: string description: Identifier of the account associated with this subscription. account: allOf: - $ref: '#/components/schemas/account' description: Information of the new account associated with the subscription. invoice_owner_account_id: type: string description: >- Identifier of the account that owns the invoice associated with this subscription. invoice_owner_account: allOf: - $ref: '#/components/schemas/account' description: Identifier of the account that owns the subscription. auto_renew: type: boolean description: >- If this field is set to `true`, the subscription automatically renews at the end of the current term. latest_version: type: boolean description: If true, this is the latest version of the subscription initial_term: allOf: - $ref: '#/components/schemas/term' description: Initial term information for the subscription. current_term: allOf: - $ref: '#/components/schemas/term' description: Current term information for the subscription renewal_term: allOf: - $ref: '#/components/schemas/term' description: Renewal term information for the subscription. start_date: type: string format: date description: Date when the subscription starts. example: '2020-01-01' end_date: type: string format: date description: Date when the subscription ends. example: '2023-01-01' description: type: string description: >- Description of the subscription. Often useful for displaying to users. contract_effective: type: string format: date description: Date when the subscriber contract is effective. example: '2023-01-01' service_activation: type: string format: date description: Date when the subscribed-to service is activated. example: '2023-01-01' customer_acceptance: type: string format: date description: >- Date when all the services or products in the subscription are accepted by the subscriber. example: '2023-01-01' invoice_separately: type: boolean description: >- If true, the subscription is billed separately from other subscriptions. If false, the subscription is included with other subscriptions in the account invoice. The default is false. order_number: type: string description: The order number of the order created by Zuora. subscription_plans: allOf: - $ref: '#/components/schemas/subscriptionPlanListResponse' readOnly: true description: List of subscription plans. invoice_items: allOf: - $ref: '#/components/schemas/invoiceItemListResponse' readOnly: true description: List of invoice items. prepaid_balance: type: array items: $ref: '#/components/schemas/prepaidBalance' readOnly: true description: >- Total prepaid units available during a subscription. It is an aggregate of all funds under a subscription. contracted_mrr: type: string description: Monthly recurring revenue of the subscription. bill_to_id: type: string nullable: true x-extra-field-annotation: '@JsonAdapter(NullableFieldAdapter.class)' description: ID of the bill-to contact. example: 2c92c0f86a8dd422016a9e7a70116b0d payment_terms: type: string nullable: true x-extra-field-annotation: '@JsonAdapter(NullableFieldAdapter.class)' description: The name of payment term associated with the invoice. bill_to: allOf: - $ref: '#/components/schemas/contact' readOnly: true description: The billing address for the customer. billing_document_settings: allOf: - $ref: '#/components/schemas/flexibleBillingDocumentSettings' description: The billing document settings for the customer. sold_to_id: type: string nullable: true x-extra-field-annotation: '@JsonAdapter(NullableFieldAdapter.class)' description: ID of the sold-to contact. example: 2c92c0f86a8dd422016a9e7a70116b0d sold_to: allOf: - $ref: '#/components/schemas/contact' readOnly: true description: The selling address for the customer. actions: allOf: - $ref: '#/components/schemas/orderActionListResponse' order: allOf: - $ref: '#/components/schemas/subscriptionVersionOrder' subscriptionVersionListResponse: type: object title: SubscriptionVersionListResponse description: '' nullable: false additionalProperties: false properties: next_page: type: string nullable: true data: type: array items: $ref: '#/components/schemas/subscriptionVersion' refundTransactions: type: object title: RefundTransactions description: '' nullable: false additionalProperties: false properties: refund_number: type: string invoice_numbers: type: array items: type: string state: allOf: - type: object properties: succeeded: type: string readOnly: true failed: type: string readOnly: true refunds: allOf: - $ref: '#/components/schemas/refund' description: The related invoices. paymentTransactions: type: object title: PaymentTransactions description: '' nullable: false additionalProperties: false properties: payment_number: type: string description: The number of the payment. amount: type: array items: type: string description: The payment transaction amount. state: allOf: - type: object properties: succeeded: type: string readOnly: true failed: type: string readOnly: true description: The state of the payment. payments: allOf: - $ref: '#/components/schemas/payment' description: The related payments. arTransactions: type: object title: ArTransactions description: '' nullable: false additionalProperties: false properties: credit_memo_numbers: type: array items: type: string description: Credit memo numbers. credit_memos: allOf: - $ref: '#/components/schemas/creditMemo' description: The related credit memos. invoice_numbers: type: array items: type: string description: The related invoice numbers. invoices: allOf: - $ref: '#/components/schemas/invoice' description: The related invoices. refunds: type: array items: $ref: '#/components/schemas/refundTransactions' description: The related refunds. payments: type: array items: $ref: '#/components/schemas/paymentTransactions' description: The related payments. writeOff: type: object title: WriteOff description: '' nullable: false additionalProperties: false properties: amount: type: string description: The total billing document amount that is written off. failed_reason: type: string description: Reasons for failure. invoice_number: type: string description: The invoice number. invoice: allOf: - $ref: '#/components/schemas/invoice' description: The related invoice. state: allOf: - type: object properties: succeeded: type: string readOnly: true failed: type: string readOnly: true description: The states of the transactions. credit_memo_number: type: string description: The credit memo number. subscriptionCancelResponse: type: object title: SubscriptionCancelResponse description: '' nullable: false additionalProperties: false properties: id: type: string readOnly: true description: Unique identifier for the object. updated_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who last updated the object updated_time: type: string format: date-time readOnly: true description: >- The date and time when the object was last updated in ISO 8601 UTC format. created_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who created the object created_time: type: string format: date-time readOnly: true description: >- The date and time when the object was created in ISO 8601 UTC format. custom_fields: type: object title: CustomFields description: >- Set of user-defined fields associated with this object. Useful for storing additional information about the object in a structured format. x-extra-field-annotation: '@JsonAdapter(CustomFieldAdapter.class)' additionalProperties: true custom_objects: oneOf: - $ref: '#/components/schemas/listCustomObjectResponse' - $ref: '#/components/schemas/custom_object' readOnly: true description: The custom objects associated with a Zuora standard object. subscription_number: type: string description: >- Human-readable identifier of the subscription. It can be user-supplied. state: type: string enum: - draft - pending_activation - pending_acceptance - active - expired - canceled - paused description: Status of the subscription. version: type: integer description: >- The version of the subscription. This version can be used in the `filter[]` query parameter to filter subscriptions. account_id: type: string description: Identifier of the account associated with this subscription. account: allOf: - $ref: '#/components/schemas/account' description: Information of the new account associated with the subscription. invoice_owner_account_id: type: string description: >- Identifier of the account that owns the invoice associated with this subscription. invoice_owner_account: allOf: - $ref: '#/components/schemas/account' description: Identifier of the account that owns the subscription. auto_renew: type: boolean description: >- If this field is set to `true`, the subscription automatically renews at the end of the current term. latest_version: type: boolean description: If true, this is the latest version of the subscription initial_term: allOf: - $ref: '#/components/schemas/term' description: Initial term information for the subscription. current_term: allOf: - $ref: '#/components/schemas/term' description: Current term information for the subscription renewal_term: allOf: - $ref: '#/components/schemas/term' description: Renewal term information for the subscription. start_date: type: string format: date description: Date when the subscription starts. example: '2020-01-01' end_date: type: string format: date description: Date when the subscription ends. example: '2023-01-01' description: type: string description: >- Description of the subscription. Often useful for displaying to users. contract_effective: type: string format: date description: Date when the subscriber contract is effective. example: '2023-01-01' service_activation: type: string format: date description: Date when the subscribed-to service is activated. example: '2023-01-01' customer_acceptance: type: string format: date description: >- Date when all the services or products in the subscription are accepted by the subscriber. example: '2023-01-01' invoice_separately: type: boolean description: >- If true, the subscription is billed separately from other subscriptions. If false, the subscription is included with other subscriptions in the account invoice. The default is false. order_number: type: string description: The order number of the order created by Zuora. subscription_plans: allOf: - $ref: '#/components/schemas/subscriptionPlanListResponse' readOnly: true description: List of subscription plans. invoice_items: allOf: - $ref: '#/components/schemas/invoiceItemListResponse' readOnly: true description: List of invoice items. prepaid_balance: type: array items: $ref: '#/components/schemas/prepaidBalance' readOnly: true description: >- Total prepaid units available during a subscription. It is an aggregate of all funds under a subscription. contracted_mrr: type: string description: Monthly recurring revenue of the subscription. bill_to_id: type: string nullable: true x-extra-field-annotation: '@JsonAdapter(NullableFieldAdapter.class)' description: ID of the bill-to contact. example: 2c92c0f86a8dd422016a9e7a70116b0d payment_terms: type: string nullable: true x-extra-field-annotation: '@JsonAdapter(NullableFieldAdapter.class)' description: The name of payment term associated with the invoice. bill_to: allOf: - $ref: '#/components/schemas/contact' readOnly: true description: The billing address for the customer. billing_document_settings: allOf: - $ref: '#/components/schemas/flexibleBillingDocumentSettings' description: The billing document settings for the customer. sold_to_id: type: string nullable: true x-extra-field-annotation: '@JsonAdapter(NullableFieldAdapter.class)' description: ID of the sold-to contact. example: 2c92c0f86a8dd422016a9e7a70116b0d sold_to: allOf: - $ref: '#/components/schemas/contact' readOnly: true description: The selling address for the customer. ar_transactions: allOf: - $ref: '#/components/schemas/arTransactions' readOnly: true write_offs: type: array items: $ref: '#/components/schemas/writeOff' readOnly: true description: The billing documents that are written off. subscriptionTermPatchResponse: type: object title: SubscriptionTermPatchResponse description: Term information of the subscription. additionalProperties: false properties: current_term: allOf: - $ref: '#/components/schemas/term' description: Current term information for the subscription. renewal_term: allOf: - $ref: '#/components/schemas/term' description: Renewal term information for the subscription. auto_renew: type: boolean description: >- If true, the subscription automatically renews at the end of the current term. subscriptionAddPlanPatchResponse: type: object title: SubscriptionAddPlanPatchResponse description: '' nullable: false additionalProperties: false properties: unique_token: type: string description: >- A unique string to represent the subscription plan in the order. The unique token is used to perform multiple actions against a newly added subscription plan. For example, if you want to add and update a product in the same order, assign a unique token to the newly added subscription plan and use that token in future order actions. plan_id: type: string description: >- The id of the subscription plan to be updated. It can be the latest version or any history version id. custom_fields: $ref: '#/components/schemas/customFields' subscription_items: type: array items: allOf: - $ref: '#/components/schemas/subscriptionItem' readOnly: true subscriptionRemovePlanPatchResponse: type: object title: SubscriptionRemovePlanPatchResponse description: '' nullable: false additionalProperties: false properties: subscription_plan_id: type: string description: Identifier of the subscription plan. subscriptionRenewPatchResponse: type: object title: SubscriptionRenewPatchResponse description: Specify this field to renew a subscription additionalProperties: false properties: terms: allOf: - $ref: '#/components/schemas/subscriptionTermPatchResponse' subscriptionUpdatePlanPatchResponse: type: object title: SubscriptionUpdatePlanPatchResponse description: '' nullable: false additionalProperties: false properties: unique_token: type: string description: >- A unique string to represent the subscription plan in the order. The unique token is used to perform multiple actions against a newly added subscription plan. For example, if you want to add and update a product in the same order, assign a unique token to the newly added subscription plan and use that token in future order actions. plan_id: type: string description: >- The id of the subscription plan to be updated. It can be the latest version or any history version id. custom_fields: $ref: '#/components/schemas/customFields' subscription_items: type: array items: allOf: - $ref: '#/components/schemas/subscriptionItem' readOnly: true subscriptionCancelPatchResponse: type: object title: SubscriptionCancelPatchResponse description: Specify this field to cancel a subscription additionalProperties: false properties: cancel_date: type: string format: date description: Date on which the subscription is canceled. example: '2022-06-01' cancel_at: type: string enum: - invoice_period_end - subscription_term_end description: >- The date on which the subscription is canceled. Can be either the end of the subscription term or the end of the billing period. subscriptionReplacePlanPatchResponse: type: object title: SubscriptionReplacePlanPatchResponse description: '' nullable: false additionalProperties: false properties: previous_subscription_plan_id: type: string description: Identifier of the subscription plan. previous_plan_id: type: string description: Identifier of the plan to be removed. replace_at: type: string enum: - now - end_of_billing_period - specific_date description: >- The date when the replacement occurs. It can be either the current date or the end of the current billing period. replacement_type: type: string enum: - upgrade - downgrade - crossgrade - other description: The type of the replacement. unique_token: type: string description: >- A unique string to represent the subscription plan in the order. The unique token is used to perform multiple actions against a newly added subscription plan. For example, if you want to add and update a product in the same order, assign a unique token to the newly added subscription plan and use that token in future order actions. plan_id: type: string description: >- The id of the subscription plan to be updated. It can be the latest version or any history version id. custom_fields: $ref: '#/components/schemas/customFields' subscription_items: type: array items: allOf: - $ref: '#/components/schemas/subscriptionItem' readOnly: true subscriptionPausePatchResponse: type: object title: SubscriptionPausePatchResponse description: Specify this field if you want to pause a subscription. additionalProperties: false properties: pause_date: type: string x-zuora-field-type: date description: Date on which the subscription is paused. pause_at: type: string enum: - invoice_period_end description: >- Can be either the end of the current billing period or a specific date. pause_interval_count: type: number description: >- The number of intervals in a duration where the subscription is paused. For example, pause_interval=year and pause_interval_count=1 represents a 1-year pause. pause_interval: type: string enum: - month - day - year - week description: >- Unit in which the pause duration is defined. One of day, week, month or year. resume_behavior: $ref: '#/components/schemas/resumeSubscriptionRequest' custom_fields: $ref: '#/components/schemas/customFields' subscriptionResumePatchResponse: type: object title: SubscriptionResumePatchResponse description: Specify this field if you want to resume a subscription. additionalProperties: false properties: extend_term: type: boolean default: false description: >- If this field is set to `true`, the subscription term is extended by the length of time the subscription is paused. resume_date: type: string x-zuora-field-type: date description: Date on which the paused subscription is resumed. resume_at: type: string enum: - pause_date description: >- You can use this field to resume a paused subscription from the pause date. custom_fields: $ref: '#/components/schemas/customFields' orderAction: type: object title: OrderAction description: '' nullable: false additionalProperties: false properties: action_id: type: string description: Identifier of the action. type: type: string enum: - create_subscription - terms - add_subscription_plan - update_subscription_plan - remove_subscription_plan - renew - cancel - owner_transfer - pause - resume - replace_subscription_plan description: The action associated with this metric. sequence: type: integer description: The sequence number of the action. start_on: type: object title: StartOnResponse description: Indicates on which date the subscription becomes effective. additionalProperties: false properties: contract_effective: type: string format: date description: >- Effective contract date for this subscription, in the `yyyy-mm-dd` format. example: '2022-06-01' service_activation: type: string format: date description: >- The date on which the services or products within a subscription have been activated and access has been provided to the customer, as the `yyyy-mm-dd` format. example: '2022-06-01' customer_acceptance: type: string format: date description: >- The date on which the services or products within a subscription have been accepted by the customer, in the `yyyy-mm-dd` format. example: '2022-06-01' subscription_plans: allOf: - $ref: '#/components/schemas/subscriptionPlanListResponse' description: Specify this field to add new plans to the new subscription. add_subscription_plan: allOf: - $ref: '#/components/schemas/subscriptionAddPlanPatchResponse' description: >- Specify this field to add subscription plans to existing subscriptions. remove_subscription_plan: allOf: - $ref: '#/components/schemas/subscriptionRemovePlanPatchResponse' description: >- Specify this field to remove subscription plans from existing subscriptions. update_subscription_plan: allOf: - $ref: '#/components/schemas/subscriptionUpdatePlanPatchResponse' description: >- Specify this field to update subscription plans on the existing subscriptions. replace_subscription_plan: allOf: - $ref: '#/components/schemas/subscriptionReplacePlanPatchResponse' description: >- Specify this field to replace existing subscription plans with new plans. renew: allOf: - $ref: '#/components/schemas/subscriptionRenewPatchResponse' description: Specify this field to renew an existing subscription. terms: allOf: - $ref: '#/components/schemas/subscriptionTermPatchResponse' cancel: allOf: - $ref: '#/components/schemas/subscriptionCancelPatchResponse' description: Specify this field to cancel an existing subscription. pause: allOf: - $ref: '#/components/schemas/subscriptionPausePatchResponse' description: Specify this field to pause an existing subscription. resume: allOf: - $ref: '#/components/schemas/subscriptionResumePatchResponse' description: Specify this field to resume a paused subscription. postSubscriptionOrderResponse: type: object title: PostSubscriptionOrderResponse description: '' nullable: false additionalProperties: false properties: id: type: string readOnly: true description: Unique identifier for the object. updated_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who last updated the object updated_time: type: string format: date-time readOnly: true description: >- The date and time when the object was last updated in ISO 8601 UTC format. created_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who created the object created_time: type: string format: date-time readOnly: true description: >- The date and time when the object was created in ISO 8601 UTC format. custom_fields: type: object title: CustomFields description: >- Set of user-defined fields associated with this object. Useful for storing additional information about the object in a structured format. x-extra-field-annotation: '@JsonAdapter(CustomFieldAdapter.class)' additionalProperties: true custom_objects: oneOf: - $ref: '#/components/schemas/listCustomObjectResponse' - $ref: '#/components/schemas/custom_object' readOnly: true description: The custom objects associated with a Zuora standard object. subscription_number: type: string description: >- Human-readable identifier of the subscription. It can be user-supplied. state: type: string enum: - draft - pending_activation - pending_acceptance - active - expired - canceled - paused description: Status of the subscription. version: type: integer description: >- The version of the subscription. This version can be used in the `filter[]` query parameter to filter subscriptions. account_id: type: string description: Identifier of the account associated with this subscription. account: allOf: - $ref: '#/components/schemas/account' description: Information of the new account associated with the subscription. invoice_owner_account_id: type: string description: >- Identifier of the account that owns the invoice associated with this subscription. invoice_owner_account: allOf: - $ref: '#/components/schemas/account' description: Identifier of the account that owns the subscription. auto_renew: type: boolean description: >- If this field is set to `true`, the subscription automatically renews at the end of the current term. latest_version: type: boolean description: If true, this is the latest version of the subscription initial_term: allOf: - $ref: '#/components/schemas/term' description: Initial term information for the subscription. current_term: allOf: - $ref: '#/components/schemas/term' description: Current term information for the subscription renewal_term: allOf: - $ref: '#/components/schemas/term' description: Renewal term information for the subscription. start_date: type: string format: date description: Date when the subscription starts. example: '2020-01-01' end_date: type: string format: date description: Date when the subscription ends. example: '2023-01-01' description: type: string description: >- Description of the subscription. Often useful for displaying to users. contract_effective: type: string format: date description: Date when the subscriber contract is effective. example: '2023-01-01' service_activation: type: string format: date description: Date when the subscribed-to service is activated. example: '2023-01-01' customer_acceptance: type: string format: date description: >- Date when all the services or products in the subscription are accepted by the subscriber. example: '2023-01-01' invoice_separately: type: boolean description: >- If true, the subscription is billed separately from other subscriptions. If false, the subscription is included with other subscriptions in the account invoice. The default is false. order_number: type: string description: The order number of the order created by Zuora. subscription_plans: allOf: - $ref: '#/components/schemas/subscriptionPlanListResponse' readOnly: true description: List of subscription plans. invoice_items: allOf: - $ref: '#/components/schemas/invoiceItemListResponse' readOnly: true description: List of invoice items. prepaid_balance: type: array items: $ref: '#/components/schemas/prepaidBalance' readOnly: true description: >- Total prepaid units available during a subscription. It is an aggregate of all funds under a subscription. contracted_mrr: type: string description: Monthly recurring revenue of the subscription. bill_to_id: type: string nullable: true x-extra-field-annotation: '@JsonAdapter(NullableFieldAdapter.class)' description: ID of the bill-to contact. example: 2c92c0f86a8dd422016a9e7a70116b0d payment_terms: type: string nullable: true x-extra-field-annotation: '@JsonAdapter(NullableFieldAdapter.class)' description: The name of payment term associated with the invoice. bill_to: allOf: - $ref: '#/components/schemas/contact' readOnly: true description: The billing address for the customer. billing_document_settings: allOf: - $ref: '#/components/schemas/flexibleBillingDocumentSettings' description: The billing document settings for the customer. sold_to_id: type: string nullable: true x-extra-field-annotation: '@JsonAdapter(NullableFieldAdapter.class)' description: ID of the sold-to contact. example: 2c92c0f86a8dd422016a9e7a70116b0d sold_to: allOf: - $ref: '#/components/schemas/contact' readOnly: true description: The selling address for the customer. actions: type: array items: $ref: '#/components/schemas/orderAction' ar_transactions: allOf: - $ref: '#/components/schemas/arTransactionsOrders' orderSubscriptionPreviewResponse: type: object title: OrderSubscriptionPreviewResponse description: '' nullable: false additionalProperties: false properties: subscription_number: type: string description: >- Human-readable identifier of the subscription. It can be user-supplied. actions: type: array items: allOf: - $ref: '#/components/schemas/subscriptionPreviewActionsResponse' orderPreviewResponse: type: object title: OrderPreviewResponse description: '' nullable: false additionalProperties: false properties: subscriptions: type: array items: allOf: - $ref: '#/components/schemas/orderSubscriptionPreviewResponse' billing_documents: type: array items: allOf: - $ref: >- #/components/schemas/subscriptionPreviewBillingDocumentsResponse line_items: type: array items: allOf: - $ref: '#/components/schemas/lineItemsPreviewResponse' description: The order line items on this order. subscriptionPlan: type: object title: SubscriptionPlan description: Subscription plan information. additionalProperties: false properties: id: type: string readOnly: true description: Unique identifier for the object. updated_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who last updated the object updated_time: type: string format: date-time readOnly: true description: >- The date and time when the object was last updated in ISO 8601 UTC format. created_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who created the object created_time: type: string format: date-time readOnly: true description: >- The date and time when the object was created in ISO 8601 UTC format. custom_fields: type: object title: CustomFields description: >- Set of user-defined fields associated with this object. Useful for storing additional information about the object in a structured format. x-extra-field-annotation: '@JsonAdapter(CustomFieldAdapter.class)' additionalProperties: true custom_objects: oneOf: - $ref: '#/components/schemas/listCustomObjectResponse' - $ref: '#/components/schemas/custom_object' readOnly: true description: The custom objects associated with a Zuora standard object. subscription: allOf: - $ref: '#/components/schemas/subscription' description: The subscription to which this subscription plan belongs. subscription_id: type: string description: Identifier of the subscription this subscription plan belongs to. product_id: type: string description: Identifier of the product associated with this subscription plan. plan_id: type: string description: Identifier of the plan associated with this subscription plan. plan: allOf: - $ref: '#/components/schemas/plan' description: The plan object associated with this subscription plan. product: allOf: - $ref: '#/components/schemas/product' description: The product associated with the subscription plan. name: type: string description: The name of the subscription plan. subscription_items: allOf: - $ref: '#/components/schemas/subscriptionItemListResponse' readOnly: true description: List of subscription items. subscriptionPlanListResponse: type: object title: SubscriptionPlanListResponse description: A list of subscription plans additionalProperties: false properties: next_page: type: string nullable: true data: type: array items: $ref: '#/components/schemas/subscriptionPlan' subscriptionItemPrepaymentField: type: object title: SubscriptionItemPrepaymentField description: The prepayment information. additionalProperties: false properties: quantity: type: number description: The number of units included in a prepayment charge. validity_period: type: string enum: - subscription_term - annual - semi_annual - quarter - month description: >- The period in which the prepayment units are valid to use as defined in a prepayment charge. subscriptionItemDrawdownField: type: object title: SubscriptionItemDrawdownField description: The drawdown information. additionalProperties: false properties: conversion_rate: type: number description: >- The conversion rate between usage unit of measure (UOM) and drawdown unit of measure for a drawdown charge. **Note**: The `conversion_rate` and `unit_of_measure` fields need to have values or be empty at the same time. subscriptionItem: type: object title: SubscriptionItem description: Subscription item information. additionalProperties: false properties: id: type: string readOnly: true description: Unique identifier for the object. updated_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who last updated the object updated_time: type: string format: date-time readOnly: true description: >- The date and time when the object was last updated in ISO 8601 UTC format. created_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who created the object created_time: type: string format: date-time readOnly: true description: >- The date and time when the object was created in ISO 8601 UTC format. custom_fields: type: object title: CustomFields description: >- Set of user-defined fields associated with this object. Useful for storing additional information about the object in a structured format. x-extra-field-annotation: '@JsonAdapter(CustomFieldAdapter.class)' additionalProperties: true custom_objects: oneOf: - $ref: '#/components/schemas/listCustomObjectResponse' - $ref: '#/components/schemas/custom_object' readOnly: true description: The custom objects associated with a Zuora standard object. subscription_item_number: type: string description: >- Human-readable identifier of the subscription item. It can be user-supplied. name: type: string description: The name of the subscription item. description: type: string description: >- An arbitrary string attached to the object. Often useful for displaying to users. product_id: type: string description: >- Identifier of the product with which this subscription is associated. charged_through_date: type: string format: date description: >- The date through which a customer has been billed for the subscription item. recurring: type: object title: Recurring description: The recurring components of a price such as interval and usage. additionalProperties: false properties: recurring_on: type: string enum: - _1 - _2 - _3 - _4 - _5 - _6 - _7 - _8 - _9 - _10 - _11 - _12 - _13 - _14 - _15 - _16 - _17 - _18 - _19 - _20 - _21 - _22 - _23 - _24 - _25 - _26 - _27 - _28 - _29 - _30 - _31 - subscription_item_start_day - account_cycle_date - subscription_start_day - term_end_day - monday - tuesday - wednesday - thursday - friday - saturday - sunday description: >- Specifies on which day or the month or day of the week a customer shall be billed. 'on': type: string enum: - _1 - _2 - _3 - _4 - _5 - _6 - _7 - _8 - _9 - _10 - _11 - _12 - _13 - _14 - _15 - _16 - _17 - _18 - _19 - _20 - _21 - _22 - _23 - _24 - _25 - _26 - _27 - _28 - _29 - _30 - _31 - subscription_item_start_day - account_cycle_date - subscription_start_day - term_end_day - monday - tuesday - wednesday - thursday - friday - saturday - sunday deprecated: true x-replaced-by: recurring_on description: >- Specifies on which day or the month or day of the week a customer shall be billed. usage: type: boolean description: Indicates that this is a usage price. interval: type: string enum: - month - year - week - term - day description: >- Specifies the billing frequency. One of `week`, `month` or `year`. interval_count: type: integer description: >- The number of intervals (specified in the interval attribute) between subscription billings. For example, interval=month and intervalCount=3 bills every 3 months. alignment_behavior: type: string enum: - subscription_start - term_start - term_end - none description: >- Specifies how to align billing for recurring (subscription) products that start on different days. timing: type: string enum: - in_advance - in_arrears description: >- You can choose to bill in_advance or in_arrears for recurring prices. The field is not used with one-time or usage-based prices. formula: type: string readOnly: true description: >- You can choose to bill in_advance or in_arrears for recurring prices. The field is not used with one-time or usage-based prices. duration_interval: type: string enum: - day - week - month - year - subscription_term - billing_period description: >- Specifies the duration frequency. One of day, week, month or year. duration_interval_count: type: integer description: >- Specifies how long a customer shall be charged if this is less than the duration of the subscription rating_group: type: string enum: - billing_period - usage_start_date - usage_record - usage_upload - custom_group description: >- A rating group based on which usage records are rated. Only applicable to usage prices. active: type: boolean description: >- Indicates whether the price is active and can be used for new purchases. state: type: string enum: - inactive - active - expired description: >- Based on the current date to populate a state field with the enumeration: [inactive, active, expired] where inactive would represent charge segments with a start_date in the future and expired charge segments with an end_date in the past. start_event: type: string enum: - contract_effective - service_activation - customer_acceptance - specific_date description: Specifies when to start billing your customer. tiers_mode: type: string enum: - graduated - volume - high_watermark_volume - high_watermark_graduated - graduated_with_overage description: Specifies the kind of tiering. tiers: type: array items: $ref: '#/components/schemas/itemTier' tax_code: type: string description: >- A tax code identifier. If the `tax_code` of a price is not provided when you create or override a price, Zuora will treat the charged amount as non-taxable. If this code is provide, Zuora considers that this price is taxable and the charged amount will be handled accordingly. tax_inclusive: type: boolean description: >- If this field is set to `true`, it indicates that amounts are inclusive of tax. unit_of_measure: type: string description: >- A configured unit of measure. This field is required for per-unit prices. quantity: type: number description: Quantity of the product to which your customers subscribe. amount: type: number description: >- The amount of the price. Specify this field if you want to override the original price with a flat-fee price unit_amount: type: number description: >- The unit amount of the price. Specify this field if you want to override the original price with a per-unit price. discount_amount: type: number description: >- Discount amount. Specify this field if you offer an amount-based discount. discount_percent: type: number description: >- Discount percent. Specify this field if you offer a percentage-based discount. apply_discount_to: type: array items: type: string enum: - one_time - recurring - usage description: Any combination of one_time, recurring and plan. discount_level: type: string enum: - account - subscription - plan description: >- Specifies at what level a discount should be applied: one of account, subscription or plan. price_base_interval: type: string enum: - month - billing_period - week description: >- Specifies the base interval of the price the subscriber is subscribed to. If not provided, this field defaults to `billing_period`. overage: type: object title: Overage description: An object defining how overage charges are calculated. additionalProperties: false properties: interval_count: type: integer description: >- Specifies the number of intervals used to calculate smoothed overage charges. type: type: string enum: - rolling_window - rollover description: 'Represents the overage type: one of rolling_window or rollover.' included_units: type: number description: >- Specifies the included units to which overage charges do not apply. credit_unused_units: type: boolean description: Specifies whether or not to credit unused units. apply_at_end_of_smoothing_period: type: boolean description: >- Indicates if the overage price is calculated at the end of the smoothing period. charge_model: type: string description: >- Charge model of the price. See [Charge models](https://knowledgecenter.zuora.com/Billing/Subscriptions/Product_Catalog/B_Charge_Models) for more information. charge_type: type: string description: >- Type of the charge. It can be one of the following types: one-time, recurring, or usage. price_id: type: string description: Identifier of the price. price: type: object title: Price description: Price information. additionalProperties: false properties: id: type: string readOnly: true description: Unique identifier for the object. updated_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who last updated the object updated_time: type: string format: date-time readOnly: true description: >- The date and time when the object was last updated in ISO 8601 UTC format. created_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who created the object created_time: type: string format: date-time readOnly: true description: >- The date and time when the object was created in ISO 8601 UTC format. custom_fields: type: object title: CustomFields description: >- Set of user-defined fields associated with this object. Useful for storing additional information about the object in a structured format. x-extra-field-annotation: '@JsonAdapter(CustomFieldAdapter.class)' additionalProperties: true custom_objects: oneOf: - $ref: '#/components/schemas/listCustomObjectResponse' - $ref: '#/components/schemas/custom_object' readOnly: true description: The custom objects associated with a Zuora standard object. name: type: string description: The name of the price. description: type: string description: >- An arbitrary string attached to the object. Often useful for displaying to users. recognized_revenue_accounting_code: type: string maxLength: 100 deprecated: true description: An active accounting code in your Zuora chart of accounts. deferred_revenue_accounting_code: type: string maxLength: 100 deprecated: true description: An active accounting code in your Zuora chart of accounts. recurring: type: object title: Recurring description: The recurring components of a price such as interval and usage. additionalProperties: false properties: recurring_on: type: string enum: - _1 - _2 - _3 - _4 - _5 - _6 - _7 - _8 - _9 - _10 - _11 - _12 - _13 - _14 - _15 - _16 - _17 - _18 - _19 - _20 - _21 - _22 - _23 - _24 - _25 - _26 - _27 - _28 - _29 - _30 - _31 - subscription_item_start_day - account_cycle_date - subscription_start_day - term_end_day - monday - tuesday - wednesday - thursday - friday - saturday - sunday description: >- Specifies on which day or the month or day of the week a customer shall be billed. 'on': type: string enum: - _1 - _2 - _3 - _4 - _5 - _6 - _7 - _8 - _9 - _10 - _11 - _12 - _13 - _14 - _15 - _16 - _17 - _18 - _19 - _20 - _21 - _22 - _23 - _24 - _25 - _26 - _27 - _28 - _29 - _30 - _31 - subscription_item_start_day - account_cycle_date - subscription_start_day - term_end_day - monday - tuesday - wednesday - thursday - friday - saturday - sunday deprecated: true x-replaced-by: recurring_on description: >- Specifies on which day or the month or day of the week a customer shall be billed. usage: type: boolean description: Indicates that this is a usage price. interval: type: string enum: - month - year - week - term - day description: >- Specifies the billing frequency. One of `week`, `month` or `year`. interval_count: type: integer description: >- The number of intervals (specified in the interval attribute) between subscription billings. For example, interval=month and intervalCount=3 bills every 3 months. alignment_behavior: type: string enum: - subscription_start - term_start - term_end - none description: >- Specifies how to align billing for recurring (subscription) products that start on different days. timing: type: string enum: - in_advance - in_arrears description: >- You can choose to bill in_advance or in_arrears for recurring prices. The field is not used with one-time or usage-based prices. formula: type: string readOnly: true description: >- You can choose to bill in_advance or in_arrears for recurring prices. The field is not used with one-time or usage-based prices. duration_interval: type: string enum: - day - week - month - year - subscription_term - billing_period description: >- Specifies the duration frequency. One of day, week, month or year. duration_interval_count: type: integer description: >- Specifies how long a customer shall be charged if this is less than the duration of the subscription rating_group: type: string enum: - billing_period - usage_start_date - usage_record - usage_upload - custom_group description: >- A rating group based on which usage records are rated. Only applicable to usage prices. start_event: type: string enum: - contract_effective - service_activation - customer_acceptance - specific_date description: Specifies when to start billing your customer. tiers_mode: type: string enum: - graduated - volume - high_watermark_volume - high_watermark_graduated - graduated_with_overage deprecated: true description: Specifies the mode for tiered prices. apply_discount_to: type: array items: type: string enum: - one_time - recurring - usage description: Any combination of one_time, recurring and plan. tiers: type: array items: $ref: '#/components/schemas/tier' description: >- Price information for different tiers. When creating or updating tiered prices, you must specify this field and the `tiers_mode` field. tax_code: type: string description: >- A tax code identifier. If a `tax_code` of a price is not provided when you create or update a price, Zuora will treat the charged amount as non-taxable. If this code is provide, Zuora considers that this price is taxable and the charged amount will be handled accordingly. tax_inclusive: type: boolean description: >- If this field is set to `true`, it indicates that amounts are inclusive of tax. unit_of_measure: type: string description: >- A configured unit of measure. This field is required for per-unit prices. quantity: type: number description: Quantity of the product to which your customers subscribe. min_quantity: type: number description: >- The minimum quantity for a price. Specify this field and the `max_quantity` field to create a range of quantities allowed in a price. max_quantity: type: number description: >- The maximum quantity for a price. Specify this field and the `min_quantity` field to create a range of quantities allowed in a price. discount_level: type: string enum: - account - subscription - plan description: >- Specifies at what level a discount should be applied: account, subscription, or plan. revenue_recognition_rule: type: string enum: - on_invoice - daily_over_time description: >- Determines when to recognize the revenue for this charge. You can choose to recognize upon invoicing or daily over time. stacked_discount: type: boolean description: >- This field is only applicable for the Percentage Discount price. This field indicates whether the discount is to be calculated as stacked discount. Possible values are as follows: For more information, see Stacked discounts amounts: type: object additionalProperties: type: number example: USD: 10 GBP: 15 unit_amounts: type: object additionalProperties: type: number example: USD: 10 GBP: 15 discount_amounts: type: object additionalProperties: type: number example: USD: 10 GBP: 15 discount_percent: type: number description: >- Discount percent. Specify this field if you offer a percentage-based discount. price_base_interval: type: string enum: - month - billing_period - week description: >- Specifies the base interval of a price. If not provided, this field defaults to `billing_period`. overage: allOf: - $ref: '#/components/schemas/overage' deprecated: true revenue: allOf: - $ref: '#/components/schemas/revenue' accounting_code: type: string description: >- An active accounting code defined in **Finance Settings > Configure Accounting Codes** in your Zuora tenant. prepayment: type: object title: Prepayment description: '' nullable: false additionalProperties: false properties: credit_option: type: string enum: - time_based - consumption_based - full_credit description: >- The way to calculate credit. See Credit Option for more information. quantity: type: number description: The number of units included in a prepayment charge. total_quantity: type: number description: >- The total amount of units that end customers can use during a validity period when they subscribe to a prepayment charge. unit_of_measure: type: string description: >- A configured unit of measure. This field is required for per-unit prices. validity_period: type: string enum: - subscription_term - annual - semi_annual - quarter - month description: >- The period in which the prepayment units are valid to use as defined in a prepayment charge. drawdown: type: object title: Drawdown description: '' nullable: false additionalProperties: false properties: conversion_rate: type: number description: >- The conversion rate between usage unit of measure (UOM) and drawdown unit of measure for a drawdown charge. **Note**: The `conversion_rate` and `unit_of_measure` fields need to have values or be empty at the same time. unit_of_measure: type: string description: Unit of measurement for a drawdown charge. taxable: type: boolean plan_id: type: string description: Specify the ID of a plan to which this price is associated. plan_number: type: string description: >- Specify the number of a plan to which this price is associated. This field is required if plan_id is not supplied custom_field_per_unit_rate: type: string writeOnly: true description: >- Name of the custom field that will be used to set a per unit rate under the `Pre-Rated Per Unit` charge model custom_field_total_amount: type: string writeOnly: true description: >- Name of the custom field that will be used to set a total amount under the `Pre-Rated` charge model product_id: type: string description: Identifier of the product. active: type: boolean deprecated: true description: Whether the price can be used for new purchases. charge_type: type: string description: The type of charge. Can be `one_time`,`recurring`, or `usage`. charge_model: type: string description: >- The charge model of the price, which determines how users are charged. Common charge models include flat fee, per-unit, volume, and tiered prices. subscription_plan_id: type: string description: >- Identifier of the subscription plan this subscription item belongs to. subscription_plan: type: object title: SubscriptionPlan description: Subscription plan information. additionalProperties: false properties: id: type: string readOnly: true description: Unique identifier for the object. updated_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who last updated the object updated_time: type: string format: date-time readOnly: true description: >- The date and time when the object was last updated in ISO 8601 UTC format. created_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who created the object created_time: type: string format: date-time readOnly: true description: >- The date and time when the object was created in ISO 8601 UTC format. custom_fields: type: object title: CustomFields description: >- Set of user-defined fields associated with this object. Useful for storing additional information about the object in a structured format. x-extra-field-annotation: '@JsonAdapter(CustomFieldAdapter.class)' additionalProperties: true custom_objects: oneOf: - $ref: '#/components/schemas/listCustomObjectResponse' - $ref: '#/components/schemas/custom_object' readOnly: true description: The custom objects associated with a Zuora standard object. subscription: allOf: - $ref: '#/components/schemas/subscription' description: The subscription to which this subscription plan belongs. subscription_id: type: string description: >- Identifier of the subscription this subscription plan belongs to. product_id: type: string description: >- Identifier of the product associated with this subscription plan. plan_id: type: string description: Identifier of the plan associated with this subscription plan. plan: allOf: - $ref: '#/components/schemas/plan' description: The plan object associated with this subscription plan. product: allOf: - $ref: '#/components/schemas/product' description: The product associated with the subscription plan. name: type: string description: The name of the subscription plan. subscription_items: allOf: - $ref: '#/components/schemas/subscriptionItemListResponse' readOnly: true description: List of subscription items. start_date: type: string format: date readOnly: true description: The date when the subscription item starts. end_date: type: string format: date readOnly: true description: The date when the subscription item ends. processed_through_date: type: string format: date readOnly: true description: >- The date until when charges are processed. When billing takes place in arrears, such as usage-based prices, this field value is the the same as the `ChargedThroughDate` value. This date is the earliest date when a charge can be amended. subscriptionItemListResponse: type: object title: SubscriptionItemListResponse description: '' nullable: false additionalProperties: false properties: next_page: type: string nullable: true data: type: array items: $ref: '#/components/schemas/subscriptionItem' billingDocumentItemListResponse: type: object title: BillingDocumentItemListResponse description: '' nullable: false additionalProperties: false properties: next_page: type: string nullable: true data: type: array items: $ref: '#/components/schemas/billingDocumentItem' billingDocumentItem: type: object title: BillingDocumentItem description: '' nullable: false additionalProperties: false properties: id: type: string readOnly: true description: Unique identifier for the object. updated_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who last updated the object updated_time: type: string format: date-time readOnly: true description: >- The date and time when the object was last updated in ISO 8601 UTC format. created_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who created the object created_time: type: string format: date-time readOnly: true description: >- The date and time when the object was created in ISO 8601 UTC format. custom_fields: type: object title: CustomFields description: >- Set of user-defined fields associated with this object. Useful for storing additional information about the object in a structured format. x-extra-field-annotation: '@JsonAdapter(CustomFieldAdapter.class)' additionalProperties: true custom_objects: oneOf: - $ref: '#/components/schemas/listCustomObjectResponse' - $ref: '#/components/schemas/custom_object' readOnly: true description: The custom objects associated with a Zuora standard object. amount: type: number description: The total amount of this billing document item. subtotal: type: number description: The total amount of this billing document item exclusive of tax. description: type: string description: >- An arbitrary string associated with the object. Often useful for displaying to users. deferred_revenue_account: type: string description: >- The accounting code for the deferred revenue, such as Monthly Recurring Liability. on_account_account: type: string description: >- The accounting code that maps to an on account in your accounting system. recognized_revenue_account: type: string description: >- The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges. billing_document: allOf: - $ref: '#/components/schemas/billingDocument' description: The related billing document. billing_document_id: type: string description: The related billing document id. revenue_recognition_rule_name: type: string description: >- The name of the revenue recognition rule governing the revenue schedule. quantity: type: number description: The number of units of this item. service_end: type: string description: >- The end date of the service period associated with this billing document item. If the associated charge is a one-time fee, then this date is the date of that charge. accounts_receivable_account: type: string description: An active account in your Zuora Chart of Accounts. discount_item: type: boolean description: If true, indicates that the item is a discount item. applied_to_item_id: type: string description: >- Identifier of an invoice item or a debit memo item that this discount item or credit memo item is applied to. service_start: type: string description: >- The start date of the service period associated with this billing document item. If the associated charge is a one-time fee, then this date is the date of that charge. accounting_code: type: string sku: type: string description: >- The unique SKU (stock keeping unit) of the product associated with this item. product_name: type: string description: The name of the product associated with this item. subscription_id: type: string description: >- The identifier of the subscription associated with the billing document item. subscription: allOf: - $ref: '#/components/schemas/subscription' description: >- The expandable subscription associated with the billing document item. tax_inclusive: type: boolean description: >- This specifies if the billing document item amount is inclusive or exclusive of tax. remaining_balance: type: number description: The remaining balance of this billing document item. unit_of_measure: type: string description: Specifies the units used to measure usage. unit_amount: type: number description: >- Unit amount (in the currency specified) of the billing document item. booking_reference: type: string description: The booking reference for this billing document item. price_description: type: string description: >- The description of the price this billing document item is associated with. name: type: string description: >- Name of the billing document item displayed to customers on the billing document. price_id: type: string description: >- The identifier of the price this billing document item is associated with. purchase_order_number: type: string description: >- The purchase order number associated with this billing document item. tax: type: number description: The amount of tax applied to the billing document item. tax_code: type: string description: The designated tax code. subscription_item_id: type: string description: >- The identifier the subscription item associated with this billing document item. subscription_item: allOf: - $ref: '#/components/schemas/subscriptionItem' description: >- The expandable subscription item associated with this billing document item. invoice_item_id: type: string description: >- The identifier of the invoice item associated with this billing document item. document_item_date: type: string format: date-time description: The date when the billing document item takes effect. example: '2022-01-01T07:08:12-07:00' taxation_items: allOf: - $ref: '#/components/schemas/taxationItemListResponse' description: List of taxation items. type: type: string enum: - credit_memo - debit_memo - invoice description: >- The type of billing document, one of credit_memo, debit_memo or invoice. billingDocumentItemCreateRequest: type: object title: BillingDocumentItemCreateRequest description: '' additionalProperties: false properties: amount: type: number description: >- Amount (in the currency specified) of the invoice item. This should always be equal to unit_amount * quantity. description: type: string description: >- An arbitrary string associated with the object. Often useful for displaying to users. deferred_revenue_account: type: string description: An active account in your Zuora Chart of Accounts. on_account_account: type: string description: An active account in your Zuora Chart of Accounts. recognized_revenue_account: type: string description: An active account in your Zuora Chart of Accounts. revenue_recognition_rule_name: type: string description: >- The name of the revenue recognition rule governing the revenue schedule. quantity: type: number description: The number of units of this item. service_end: type: string format: date description: >- The end date of the service period associated with this billing document item. If the price for the associated subscription item is a one-time fee, then this date is the date of that subscription item. example: '2022-01-01' service_start: type: string format: date description: >- The start date of the service period associated with this billing document item. If the price for the associated subscription item is a one-time fee, then this date is the date of that subscription item. example: '2022-01-01' sku: type: string description: >- The unique SKU (stock keeping unit) of the product associated with this item. tax_inclusive: type: boolean description: >- Indicates whether the billing document item amount is inclusive or exclusive of tax. unit_of_measure: type: string description: Specifies the units used to measure usage. taxation_items: type: array items: $ref: '#/components/schemas/taxationItemCreateRequest' description: List of taxation items. unit_amount: type: number description: >- Unit amount (in the currency specified) of the billing document item. booking_reference: type: string description: The booking reference for this billing document item. price_id: type: string description: >- The identifier of the price this billing document item is associated with. purchase_order_number: type: string description: >- The purchase order number associated with this billing document item. tax_code: type: string description: The designated tax code. document_item_date: type: string format: date-time description: >- The date when the billing document item takes effect. This field is applicable only if the `type` field is set to `invoice`. example: '2022-01-01T07:08:12-07:00' name: type: string description: >- Name of the billing document item displayed to customers on the billing document. invoice_item_id: type: string description: >- The identifier of the invoice item associated with this billing document item. accounting_code: type: string custom_fields: $ref: '#/components/schemas/customFields' required: - service_start subscriptionItemCreateRequest: type: object title: SubscriptionItemCreateRequest description: '' additionalProperties: false properties: price_id: type: string description: Identifier of the price. subscription_item_number: type: string description: >- Human-readable identifier of the subscription item. It can be user-supplied. description: type: string maxLength: 500 description: Description of the price. Often useful for displaying to users. recurring: $ref: '#/components/schemas/recurring' start_event: type: string enum: - contract_effective - service_activation - customer_acceptance - specific_date description: Specifies when to start billing your customer. start_date: type: string format: date description: The date when the subscription item starts end_date: type: string format: date description: The date when the subscription item ends or ended. tiers_mode: type: string enum: - graduated - volume - high_watermark_volume - high_watermark_graduated - graduated_with_overage description: Specifies the mode of tiering. tiers: type: array items: $ref: '#/components/schemas/itemTier' description: Information of all tiers if the price is a tiered price. quantity: type: number description: Quantity of the product to which your customers subscribe. amount: type: number description: >- The amount of the price. Specify this field if you want to override the original price with a flat-fee price unit_amount: type: number description: >- The unit amount of the price. Specify this field if you want to override the original price with a per-unit price. discount_amount: type: number description: >- Discount amount. Specify this field if you offer an amount-based discount. discount_percent: type: number description: >- Discount percent. Specify this field if you offer a percentage-based discount. price_base_interval: type: string enum: - month - billing_period - week description: >- Specifies the base interval of the price the subscriber is subscribed to. If not provided, this field defaults to `billing_period`. overage: $ref: '#/components/schemas/overage' unique_token: type: string maxLength: 50 description: >- Unique identifier for the price. This identifier enables you to refer to the price before the price has an internal identifier in Zuora. custom_fields: $ref: '#/components/schemas/customFields' apply_discount_to: type: array items: type: string enum: - one_time - recurring - usage description: Any combination of one-time, recurring, and usage. discount_level: type: string enum: - account - subscription - plan description: >- Specifies at what level a discount should be applied: one of account, subscription or plan. custom_field_per_unit_rate: type: string writeOnly: true description: >- Name of the custom field that will be used to set a per unit rate under the `Pre-Rated Per Unit` charge model custom_field_total_amount: type: string writeOnly: true description: >- Name of the custom field that will be used to set a total amount under the `Pre-Rated` charge model prepayment: $ref: '#/components/schemas/subscriptionItemPrepaymentField' drawdown: $ref: '#/components/schemas/subscriptionItemDrawdownField' required: - price_id subscriptionItemPatchRequest: type: object title: SubscriptionItemPatchRequest description: '' nullable: false additionalProperties: false properties: id: type: string description: Identifier of the subscription item. recurring: $ref: '#/components/schemas/recurring' subscription_item_number: type: string description: >- Human-readable identifier of the subscription. It can be user-supplied. custom_fields: $ref: '#/components/schemas/customFields' description: type: string description: >- An arbitrary string attached to the object. Often useful for displaying to users. start_date: type: string format: date description: The date when the subscription item starts end_date: type: string format: date description: The date when the subscription item ends or ended. apply_discount_to: type: array items: type: string enum: - one_time - recurring - usage description: Any combination of one-time, recurring, or usage prices. discount_level: type: string enum: - account - subscription - plan description: Specifies at what level a discount should be applied. start_event: type: string enum: - contract_effective - service_activation - customer_acceptance - specific_date description: Specifies when to start billing your customer. discount_percent: type: number description: >- Discount percent. Specify this field if you want to override with a discount-based discount price. quantity: type: number description: Quantity of the product to which your customers subscribe. amount: type: number description: >- The amount of the price. Specify this field if you want to override the original price with a flat-fee price unit_amount: type: number description: >- The unit amount of the price. Specify this field if you want to override the orignial price with a per-unit price. tiers: type: array items: $ref: '#/components/schemas/itemTier' description: >- Information of all tiers if you want to override the original price with a tiered price. overage: $ref: '#/components/schemas/overage' unique_token: type: string description: >- Unique identifier for the price. This identifier enables you to refer to the price before the price has an internal identifier in Zuora. prepayment: $ref: '#/components/schemas/subscriptionItemPrepaymentField' custom_field_per_unit_rate: type: string writeOnly: true description: >- Name of the custom field that will be used to set a per unit rate under the `Pre-Rated Per Unit` charge model custom_field_total_amount: type: string writeOnly: true description: >- Name of the custom field that will be used to set a total amount under the `Pre-Rated` charge model billRun: type: object title: BillRun description: '' nullable: false additionalProperties: false properties: id: type: string description: Unique identifier for this object. updated_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who last updated the object updated_time: type: string format: date-time readOnly: true description: >- The date and time when the object was last updated in ISO 8601 UTC format. created_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who created the object created_time: type: string format: date-time readOnly: true description: >- The date and time when the object was created in ISO 8601 UTC format. custom_fields: type: object title: CustomFields description: >- Set of user-defined fields associated with this object. Useful for storing additional information about the object in a structured format. x-extra-field-annotation: '@JsonAdapter(CustomFieldAdapter.class)' additionalProperties: true custom_objects: oneOf: - $ref: '#/components/schemas/listCustomObjectResponse' - $ref: '#/components/schemas/custom_object' readOnly: true description: The custom objects associated with a Zuora standard object. account_id: type: string description: Identifier of the customer account to bill. email: type: boolean description: >- If set to `true`, invoices will be automatically emailed to customers. post: type: boolean description: >- Indicates whether to automatically post a billing document after it is created. renew: type: boolean description: If set to `true`, subscriptions will be automatically renewed. day_of_month: type: string description: The day of the month to bill multiple customer accounts. bill_run_number: type: string description: Human-readable identifier for this object. bill_run_time: type: string format: date-time description: The date and time on which this bill run starts. invoice_date: type: string format: date description: The date displayed on the invoice. example: '2022-01-01' target_date: type: string format: date description: >- All unbilled items on or before this date are included in this bill run. example: '2023-01-01' state: type: string enum: - processed - pending - completed - canceled - posted - failed description: Status of the bill run. batches: type: string description: >- Identifier of the customer account batch to be included in this bill run. charges_excluded: type: string description: Type of the charge to be excluded from the bill run. email_zero_amount_invoices: type: boolean description: >- If set to `false`, invoices for zero amounts will not be emailed to customers. invoices_sent: type: boolean description: >- Indicates whether the invoices have been automatically sent to customers. last_invoice_sent_time: type: string format: date description: The date when the last invoice was sent. example: '2023-01-01' accounts_processed: type: integer description: Number of accounts billed from this bill run. invoices_generated: type: integer description: Number of invoices generated from this bill run. credit_memos_generated: type: integer description: Number of credit memos generated from this bill run. name: type: string description: The name of the bill run. BillRunCreateRequest: type: object title: BillRunCreateRequest description: '' additionalProperties: false properties: id: type: string readOnly: true description: Unique identifier for the object. updated_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who last updated the object updated_time: type: string format: date-time readOnly: true description: >- The date and time when the object was last updated in ISO 8601 UTC format. created_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who created the object created_time: type: string format: date-time readOnly: true description: >- The date and time when the object was created in ISO 8601 UTC format. custom_fields: $ref: '#/components/schemas/customFields' custom_objects: oneOf: - $ref: '#/components/schemas/listCustomObjectResponse' - $ref: '#/components/schemas/custom_object' readOnly: true description: The custom objects associated with a Zuora standard object. account_id: type: string description: >- Identifier of the customer account to bill. Specify this field or `account_number` if you want to create a bill run for a single customer. account_number: type: string description: >- Human-readable identifier of the account to bill. Specify this field or `account_id` if you want to create a bill run for a single customer. email: type: boolean description: >- If set to `true`, invoices will be automatically emailed to customers. post: type: boolean description: >- Indicates whether to automatically post a billing document after it is created. renew: type: boolean description: If set to `true`, subscriptions will be automatically renewed. day_of_month: enum: - '1' - '2' - '3' - '4' - '5' - '6' - '7' - '8' - '9' - '10' - '11' - '12' - '13' - '14' - '15' - '16' - '17' - '18' - '19' - '20' - '21' - '22' - '23' - '24' - '25' - '26' - '27' - '28' - '29' - '30' - '31' - AllBillCycleDays - AsRunDay description: >- The day of the month on which the multiple customer accounts are billed. batches: type: array items: type: string description: >- Identifier of the customer account batch to be included in this bill run. invoice_date: type: string format: date description: The date displayed on the invoice. example: '2022-01-01' target_date: type: string format: date description: >- All unbilled items on or before this date are included in this bill run. example: '2023-01-01' email_zero_amount_invoices: type: boolean default: true description: >- If it is set to `false`, invoices for zero amounts will not be emailed to customers. charges_excluded: type: array items: type: string description: Type of the charge to be excluded from the bill run. name: type: string description: The name of the bill run. type: type: string enum: - regular - catch_up description: >- The type of the bill run. This field is only available if you have the Catch-Up Bill Run feature enabled in your tenant. subscription_ids: type: array items: type: string description: >- The target subscriptions for this bill run. Note that all these subscriptions must belong to the same account. required: - invoice_date - target_date BillRunPostRequest: type: object title: BillRunPostRequest description: '' additionalProperties: false properties: invoice_date: type: string format: date description: The date printed on the invoice. example: '2022-01-01' required: - invoice_date BillRunListResponse: type: object title: BillRunListResponse description: '' nullable: false additionalProperties: false properties: next_page: type: string nullable: true data: type: array items: $ref: '#/components/schemas/billRun' billRunPreviewStateTransitions: type: object title: BillRunPreviewStateTransitions description: The timestamps at which the object's state was updated. additionalProperties: false properties: complete_time: type: string format: date-time description: The time when the bill run preview completed. processing_start_time: type: string format: date-time description: The time when the bill run preview started. billRunPreviewFile: type: object title: BillRunPreviewFile description: File containing the results of the bill run preview. additionalProperties: false properties: url: type: string description: >- The URL from which a zipped CSV file may be downloaded. This file contains the preview invoice item data and credit memo item data for the specified customer accounts. billRunPreview: type: object title: BillRunPreview description: '' nullable: false additionalProperties: false properties: id: type: string readOnly: true description: Unique identifier for the object. updated_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who last updated the object updated_time: type: string format: date-time readOnly: true description: >- The date and time when the object was last updated in ISO 8601 UTC format. created_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who created the object created_time: type: string format: date-time readOnly: true description: >- The date and time when the object was created in ISO 8601 UTC format. custom_fields: type: object title: CustomFields description: >- Set of user-defined fields associated with this object. Useful for storing additional information about the object in a structured format. x-extra-field-annotation: '@JsonAdapter(CustomFieldAdapter.class)' additionalProperties: true custom_objects: oneOf: - $ref: '#/components/schemas/listCustomObjectResponse' - $ref: '#/components/schemas/custom_object' readOnly: true description: The custom objects associated with a Zuora standard object. assume_renewal: type: string enum: - all - auto_renew_only - none description: >- Indicates whether to generate a preview of future invoice items and credit memo items with the assumption that the subscriptions are renewed. **all**: The assumption is applied to all the subscriptions. Zuora generates preview invoice item data and credit memo item data from the first day of the customer's next billing period to the target date. **auto_renew_only**: The assumption is applied to the subscriptions that have auto_renew enabled. Zuora generates preview invoice item data and credit memo item data from the first day of the customer's next billing period to the target date. batches: type: array items: type: string description: >- Identifiers of the customer account batches to be included in this bill run preview. charges_excluded: type: array items: type: string enum: - one_time - recurring - usage description: Charge type or types to be excluded from this bill run preview. include_draft_items: type: boolean description: If true, draft items will be included in this bill run preview. include_evergreen_subscriptions: type: boolean description: >- If true, evergreen subscriptions will be included in this bill run preview. target_date: type: string format: date description: >- All unbilled items on or before this date are included in this bill run. state_transitions: type: object title: BillRunPreviewStateTransitions description: The timestamps at which the object's state was updated. additionalProperties: false properties: complete_time: type: string format: date-time description: The time when the bill run preview completed. processing_start_time: type: string format: date-time description: The time when the bill run preview started. file: type: object title: BillRunPreviewFile description: File containing the results of the bill run preview. additionalProperties: false properties: url: type: string description: >- The URL from which a zipped CSV file may be downloaded. This file contains the preview invoice item data and credit memo item data for the specified customer accounts. billing_preview_run_number: type: string description: Human-readable identifier for this object. state: type: string enum: - pending - processing - completed - failed - canceled description: The state of the bill run preview. number_of_accounts_succeeded: type: number description: >- The number of the customer accounts whose bill run preview job succeeded. number_of_accounts: type: number description: >- The number of the customer accounts included in the bill run preview job. billRunPreviewCreateRequest: type: object title: BillRunPreviewCreateRequest description: '' additionalProperties: false properties: assume_renewal: type: string enum: - all - auto_renew_only - none description: >- Indicates whether to generate a preview of future invoice items and credit memo items with the assumption that the subscriptions are renewed. **all**: The assumption is applied to all the subscriptions. Zuora generates preview invoice item data and credit memo item data from the first day of the customer's next billing period to the target date. **auto_renew_only**: The assumption is applied to the subscriptions that have auto_renew enabled. Zuora generates preview invoice item data and credit memo item data from the first day of the customer's next billing period to the target date. batches: type: array items: type: string description: >- Identifiers of the customer account batches to be included in this bill run preview. charges_excluded: type: array items: type: string enum: - one_time - recurring - usage description: Charge type or types to be excluded from this bill run preview. include_draft_items: type: boolean description: If true, draft items will be included in this bill run preview. include_evergreen_subscriptions: type: boolean description: >- If true, evergreen subscriptions will be included in this bill run preview. target_date: type: string format: date description: >- All unbilled items on or before this date are included in this bill run. required: - target_date subscriptionPlanPatchRequest: type: object title: SubscriptionPlanPatchRequest description: Subscription Plan information. additionalProperties: false properties: custom_fields: $ref: '#/components/schemas/customFields' subscription_plan_id: type: string description: Identifier of the subscription plan. unique_token: type: string description: >- Unique identifier for the subscription plan. This identifier enables you to refer to the subscription plan before the subscription plan has an internal identifier in Zuora. subscription_items: type: array items: allOf: - $ref: '#/components/schemas/subscriptionItemPatchRequest' description: Subscription item information. subscriptionPlanCreateRequest: type: object title: SubscriptionPlanCreateRequest description: Subscription plan information. additionalProperties: false properties: plan_id: type: string description: Identifier of the plan associated with this subscription plan. plan_number: type: string description: >- Human-readable identifier of the plan associated with this subscription plan. prices: type: array items: allOf: - $ref: '#/components/schemas/subscriptionItemCreateRequest' description: Price information within the subscription plan. unique_token: type: string description: >- Unique identifier for the subscription plan. This identifier enables you to refer to the subscription plan before the subscription plan has an internal identifier in Zuora. custom_fields: $ref: '#/components/schemas/customFields' usageCreateRequest: type: object title: UsageCreateRequest description: '' additionalProperties: false properties: account_number: type: string description: >- Human-readable identifier of the account. It can be user-supplied. Either `account_number` or `account_id` is required. example: A-100001 account_id: type: string description: >- Identifier of the account associated with this subscription. Either `account_id` or `account_number` is required. subscription_item_id: type: string description: Identifier of the subscription item. subscription_item_number: type: string description: >- Human-readable identifier of the subscription item. It can be user-supplied. description: type: string description: >- An arbitrary string attached to the object. Often useful for displaying to users. example: description of test account end_time: type: string format: date-time description: The end time for which usage is recorded. quantity: type: number description: The number of units of this item. start_time: type: string format: date-time description: The start time for which usage is recorded. subscription_id: type: string description: >- The identifier of the subscription associated with the billing document item. subscription_number: type: string description: >- Human-readable identifier of the subscription. It can be user-supplied. unit_of_measure: type: string description: >- Specifies the units to measure usage. Units of measure are configured in Zuora Central. Your values depend on your configuration in Billing Settings. custom_fields: $ref: '#/components/schemas/customFields' required: - start_time - quantity - unit_of_measure usage: type: object title: Usage description: '' nullable: false additionalProperties: false properties: id: type: string readOnly: true description: Unique identifier for the object. updated_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who last updated the object updated_time: type: string format: date-time readOnly: true description: >- The date and time when the object was last updated in ISO 8601 UTC format. created_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who created the object created_time: type: string format: date-time readOnly: true description: >- The date and time when the object was created in ISO 8601 UTC format. custom_fields: type: object title: CustomFields description: >- Set of user-defined fields associated with this object. Useful for storing additional information about the object in a structured format. x-extra-field-annotation: '@JsonAdapter(CustomFieldAdapter.class)' additionalProperties: true custom_objects: oneOf: - $ref: '#/components/schemas/listCustomObjectResponse' - $ref: '#/components/schemas/custom_object' readOnly: true description: The custom objects associated with a Zuora standard object. account_number: type: string description: >- Human-readable identifier of the account. It can be user-supplied. Either `account_number` or `account_id` is required. example: A-100001 account_id: type: string description: >- Identifier of the account associated with this subscription. Either `account_id` or `account_number` is required. subscription_item_id: type: string description: Identifier of the subscription item. subscription_item_number: type: string description: >- Human-readable identifier of the subscription item. It can be user-supplied. description: type: string description: >- An arbitrary string attached to the object. Often useful for displaying to users. example: description of test account end_time: type: string format: date-time description: The end time for which usage is recorded. quantity: type: number description: The number of units of this item. start_time: type: string format: date-time description: The start time for which usage is recorded. subscription_id: type: string description: >- The identifier of the subscription associated with the billing document item. subscription_number: type: string description: >- Human-readable identifier of the subscription. It can be user-supplied. unit_of_measure: type: string description: >- Specifies the units to measure usage. Units of measure are configured in Zuora Central. Your values depend on your configuration in Billing Settings. state: type: string enum: - pending - processed account: allOf: - $ref: '#/components/schemas/account' description: The account that owns the usages. EXPANDABLE usagePatchRequest: type: object title: UsagePatchRequest description: '' nullable: false additionalProperties: false properties: end_time: type: string format: date-time description: The end time for which usage is recorded. quantity: type: number description: The number of units of this item. start_time: type: string format: date-time description: The start time for which usage is recorded. unit_of_measure: type: string description: >- Specifies the units to measure usage. Units of measure are configured in Zuora Central. Your values depend on your configuration in Billing Settings. custom_fields: $ref: '#/components/schemas/customFields' listUsageResponse: type: object title: ListUsageResponse description: '' nullable: false additionalProperties: false properties: next_page: type: string nullable: true data: type: array items: $ref: '#/components/schemas/usage' successResponse: type: object title: SuccessResponse properties: success: type: string workflowRun: type: object title: WorkflowRun description: '' nullable: false additionalProperties: false properties: id: type: integer description: The unique ID of an active version. type: type: string enum: - setup - instance description: >- The type of the active version. Currently the only valid value is `Workflow::Setup`. state: type: string enum: - queued - processing description: The status of an active version. original_workflow_id: type: integer description: Identifier of the original Workflow version. name: type: string description: The name of the workflow definition. created_time: type: string format: date-time updated_time: type: string format: date-time runWorkflowRequest: type: object title: RunWorkflowRequest description: '' nullable: true additionalProperties: false properties: input_parameters: type: object additionalProperties: true description: >- Include parameters that you want to pass to the workflow. For the parameters to be recognized and picked up by tasks in the workflow, you need to define the parameters first. headers: type: object title: RequestHeaders properties: zuora-track-id: type: string description: >- A custom identifier for tracking API requests. If you set a value for this header, Zuora returns the same value in the response header. This header enables you to track your API calls to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), or quote ('). async: type: boolean default: false description: >- Making asynchronous requests allows you to scale your applications more efficiently by leveraging Zuora's infrastructure to enqueue and execute requests for you without blocking. These requests also use built-in retry semantics, which makes them much less likely to fail for non-deterministic reasons, even in extreme high-throughput scenarios. Meanwhile, when you send a request to one of these endpoints, you can expect to receive a response in less than 150 milliseconds and these calls are unlikely to trigger rate limit errors. If set to true, Zuora returns a 202 Accepted response, and the response body contains only a request ID. zuora-entity-id: type: string description: >- An entity ID. If you have multi-entity enabled and the authorization token is valid for more than one entity, you must use this header to specify which entity to perform the operation on. If the authorization token is only valid for a single entity, or you do not have multi-entity enabled, you do not need to set this header. idempotency-key: type: string description: >- Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. This idempotency key should be a unique value, and the Zuora server identifies subsequent retries of the same request using this value. For more information, see [Idempotent Requests](https://developer.zuora.com/api-references/quickstart-api/tag/Idempotent-Requests/). accept-encoding: type: string description: >- Include a `accept-encoding: gzip` header to compress responses, which can reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes. For more information about this header, see [Request and Response Compression](https://developer.zuora.com/api-references/quickstart-api/tag/Request-and-Response-Compression/). content-encoding: type: string description: >- Include a `content-encoding: gzip` header to compress a request. Upload a gzipped file for the payload if you specify this header. For more information, see [Request and Response Compression](https://developer.zuora.com/api-references/quickstart-api/tag/Request-and-Response-Compression/). responseHeaders: type: object title: ResponseHeaders properties: ratelimit-limit: type: string description: >- The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information. ratelimit-remaining: type: number description: >- The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information. ratelimit-reset: type: number description: >- The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information. zuora-request-id: type: string description: Zuora’s internal identifier for this request. zuora-track-id: type: string description: >- A user-supplied identifier for this request. If you supply a `zuora-track-id` as a request header, Zuora returns the `zuora-track-id` as a response header. error: type: object title: Error description: '' nullable: false additionalProperties: false properties: code: type: string parameter: type: string message: type: string errorResponse: type: object title: ErrorResponse description: '' nullable: false additionalProperties: false properties: type: type: string errors: type: array items: $ref: '#/components/schemas/error' retryable: type: boolean paymentRunCreateRequest: type: object title: PaymentRunCreateRequest description: '' nullable: false additionalProperties: false properties: apply_credit_memos: type: boolean description: If true, any posted credit memos are applied first. apply_unapplied_payments: type: boolean description: If true, any unapplied payments are applied first. batch: type: string description: >- Identifier of the customer account batch to be included in this payment run. bill_cycle_day: type: string description: The day of the month to bill multiple customer accounts. bill_run_id: type: string description: The unique identifier of a bill run. collect_payment: type: boolean description: >- Indicates whether to process electronic payments during the execution of payment runs. If the Payment user permission "Process Electronic Payment" is disabled, this field will be ignored. currency: type: string description: Three-letter ISO currency code. example: USD consolidated_payment: type: boolean description: >- If true, a single payment will be collected for all receivables due on an account. gateway_id: type: string description: Unique identifier for the payment gateway. payment_run_date: type: string format: date-time description: >- The date and time when the scheduled payment run is to be executed, in `yyyy-mm-dd hh:mm:ss` format. The backend will ignore mintues and seconds in the field value. For example, if you specify `2017-03-01 11:30:37` for this value, this payment run will be run at 2017-03-01 11:00:00.
You must specify either the `payment_run_date` field or the `target_date` field in the request body. If you specify the `payment_run_date` field, the scheduced payment run is to be executed on the specified payment run date. If you specify the `target_date` field, the payment run is executed immediately after it is created. target_date: type: string format: date description: >- The target date used to determine which receivables to be paid in the payment run. The payments are collected for all receivables with the due date no later than the target date. example: '2023-01-01' paymentRunPatchRequest: type: object title: PaymentRunPatchRequest description: '' nullable: false additionalProperties: false properties: apply_credit_memos: type: boolean description: If true, any posted credit memos are applied first. apply_unapplied_payments: type: boolean description: If true, any unapplied payments are applied first. batch: type: string description: >- Identifier of the customer account batch to be included in this payment run. bill_cycle_day: type: string description: The day of the month to bill multiple customer accounts. bill_run_id: type: string description: The unique identifier of a bill run. collect_payment: type: boolean description: >- Indicates whether to process electronic payments during the execution of payment runs. If the Payment user permission "Process Electronic Payment" is disabled, this field will be ignored. currency: type: string description: Three-letter ISO currency code. example: USD consolidated_payment: type: boolean description: >- If true, a single payment will be collected for all receivables due on an account. gateway_id: type: string description: Unique identifier for the payment gateway. payment_run_date: type: string format: date-time description: >- The date and time when the scheduled payment run is to be executed, in `yyyy-mm-dd hh:mm:ss` format. The backend will ignore mintues and seconds in the field value. For example, if you specify `2017-03-01 11:30:37` for this value, this payment run will be run at 2017-03-01 11:00:00.
You must specify either the `payment_run_date` field or the `target_date` field in the request body. If you specify the `payment_run_date` field, the scheduced payment run is to be executed on the specified payment run date. If you specify the `target_date` field, the payment run is executed immediately after it is created. target_date: type: string format: date description: >- The target date used to determine which receivables to be paid in the payment run. The payments are collected for all receivables with the due date no later than the target date. example: '2023-01-01' paymentRunSummary: type: object title: PaymentRunSummary description: '' nullable: false additionalProperties: false properties: number_of_errors: type: integer description: The number of payments not processed. number_of_invoices: type: integer description: The number of invoices processed. number_of_payments: type: integer description: The number of payments processed. number_of_credit_memos: type: integer description: The number of credit memos processed. number_of_debit_memos: type: integer description: The number of debit memos processed. number_of_unprocessed_debit_memos: type: integer description: The number of unprocessed debit memos. number_of_unapplied_payments: type: integer description: The number of unapplied payments. number_of_unprocessed_receivables: type: integer description: The number of receivables with positive remamining balances. errors_total: type: integer description: The total number of all receivables with payments not processed. invoices_total: type: integer description: The total number of all invoices. payments_total: type: integer description: The total number of all processed and unapplied payments. unprocessed_receivables_total: type: integer description: The total number of positive remaining balances of all receivables. paymentRun: type: object title: PaymentRun description: '' nullable: false additionalProperties: false properties: id: type: string readOnly: true description: Unique identifier for the object. updated_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who last updated the object updated_time: type: string format: date-time readOnly: true description: >- The date and time when the object was last updated in ISO 8601 UTC format. created_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who created the object created_time: type: string format: date-time readOnly: true description: >- The date and time when the object was created in ISO 8601 UTC format. custom_fields: type: object title: CustomFields description: >- Set of user-defined fields associated with this object. Useful for storing additional information about the object in a structured format. x-extra-field-annotation: '@JsonAdapter(CustomFieldAdapter.class)' additionalProperties: true custom_objects: oneOf: - $ref: '#/components/schemas/listCustomObjectResponse' - $ref: '#/components/schemas/custom_object' readOnly: true description: The custom objects associated with a Zuora standard object. apply_credit_memos: type: boolean description: If true, any posted credit memos are applied first. apply_unapplied_payments: type: boolean description: If true, any unapplied payments are applied first. batch: type: string description: >- Identifier of the customer account batch to be included in this payment run. consolidate_payment: type: boolean description: >- If true, a single payment will be collected for all receivables due on an account. bill_cycle_day: type: integer minimum: 0 maximum: 31 description: The day of the month to bill multiple customer accounts. bill_run_id: type: string description: The unique identifier of a bill run. collect_payment: type: boolean description: >- Indicates whether to process electronic payments during the execution of payment runs. currency: type: string description: Three-letter ISO currency code. example: USD state_transitions: allOf: - type: object properties: completed: type: string readOnly: true failed: type: string readOnly: true description: >- The date and time when the payment run executed, in the `yyyy-mm-dd hh:mm:ss` format. payment_gateway_id: type: string description: Unique identifier for the payment gateway. payment_collection_date: type: string format: date-time readOnly: true payment_run_number: type: string description: Human-readable identifier for this object. payment_run_date: type: string format: date-time description: >- The date and time when the scheduled payment run is to be executed, in `yyyy-mm-dd hh:mm:ss` format. target_date: type: string format: date description: >- The target date used to determine which receivables to be paid in the payment run. The payments are collected for all receivables with the due date no later than the target date. example: '2023-01-01' state: type: string enum: - processing - pending - completed - canceled - failed description: Status of the payment run. summary: allOf: - $ref: '#/components/schemas/paymentRunSummary' readOnly: true description: Summary of the payment run. PaymentRunListResponse: type: object title: PaymentRunListResponse description: '' nullable: false additionalProperties: false properties: next_page: type: string nullable: true data: type: array items: $ref: '#/components/schemas/paymentRun' fulfillment: type: object title: Fulfillment description: '' nullable: false additionalProperties: false properties: id: type: string readOnly: true description: Unique identifier for the object. updated_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who last updated the object updated_time: type: string format: date-time readOnly: true description: >- The date and time when the object was last updated in ISO 8601 UTC format. created_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who created the object created_time: type: string format: date-time readOnly: true description: >- The date and time when the object was created in ISO 8601 UTC format. custom_fields: type: object title: CustomFields description: >- Set of user-defined fields associated with this object. Useful for storing additional information about the object in a structured format. x-extra-field-annotation: '@JsonAdapter(CustomFieldAdapter.class)' additionalProperties: true custom_objects: oneOf: - $ref: '#/components/schemas/listCustomObjectResponse' - $ref: '#/components/schemas/custom_object' readOnly: true description: The custom objects associated with a Zuora standard object. order_line_item_id: type: string description: The unique identifier of the associated order line item. fulfillment_number: type: string description: Human-readable identifier for the object. It can be user-supplied. fulfillment_date: type: string format: date description: The date of the fulfillment. example: '2023-01-01' type: type: string enum: - delivery - return description: The type of fulfillment. quantity: type: number description: The number of units of this item. state: type: string enum: - accepted - booked - sent_to_billing - complete - canceled description: The status of the invoice. target_date: type: string format: date description: >- All order line items associated with this fulfillment that were unbilled on or before this date are included in future bill runs. example: '2022-01-01' description: type: string description: >- An arbitrary string attached to the object. Often useful for displaying to users. tracking_number: type: string description: The tracking number of the fulfillment. carrier: type: string description: The name of the shipping carrier for this fulfillment. fulfillment_system: type: string description: The fulfillment system for the fulfillment. external_id: type: string description: An external identifier for the fulfillment. revenue: allOf: - $ref: '#/components/schemas/revenue' location: additionalProperties: true type: string description: The fulfillment location of the fulfillment. filfillmentListResponse: type: object title: FilfillmentListResponse description: '' nullable: false additionalProperties: false properties: next_page: type: string nullable: true data: type: array items: $ref: '#/components/schemas/fulfillment' fulfillmentProcessingOption: type: object title: FulfillmentProcessingOption description: '' nullable: false additionalProperties: false properties: document_date: type: string format: date description: Date on which the billing document is created or paid. target_date: type: string format: date description: >- The target date for the order to be picked up by bill run for billing. fulfillmentCreateBulkRequest: type: object title: FulfillmentCreateBulkRequest description: '' nullable: false additionalProperties: false properties: data: type: array items: $ref: '#/components/schemas/fulfillmentRequest' processing_options: $ref: '#/components/schemas/fulfillmentProcessingOption' fulfillmentCreateBulkResponse: type: object title: FulfillmentCreateBulkResponse description: '' nullable: false additionalProperties: false properties: data: type: array items: $ref: '#/components/schemas/fulfillment' amount_paid: type: number description: The total amount collected by this request. payment_number: type: string description: >- Human-readable identifier of the payment associated with this fulfillment. credit_memo_numbers: type: array items: type: string description: >- Human-readable identifiers of any credit memos associated with this request. invoice_numbers: type: array items: type: string description: >- Human-readable identifiers of any invoices associated with this request. fulfillmentCreateRequest: type: object title: FulfillmentCreateRequest allOf: - $ref: '#/components/schemas/fulfillmentRequest' properties: processing_options: $ref: '#/components/schemas/fulfillmentProcessingOption' fulfillmentRequest: type: object title: FulfillmentRequest description: '' nullable: false additionalProperties: false properties: order_line_item_id: type: string description: The unique identifier of the associated order line item. carrier: type: string description: The name of the shipping carrier for this fulfillment. custom_fields: $ref: '#/components/schemas/customFields' description: type: string description: >- An arbitrary string attached to the object. Often useful for displaying to users. revenue: allOf: - $ref: '#/components/schemas/revenue' external_id: type: string description: An external identifier for the fulfillment fulfillment_date: type: string format: date description: The date of the fulfillment. example: '2022-01-01' location: type: string description: The fulfillment location of the fulfillment. fulfillment_system: type: string description: The fulfillment system for the fulfillment. type: type: string enum: - delivery - return description: The type of fulfillment. quantity: type: number description: The number of units of this item. state: type: string enum: - accepted - booked - sent_to_billing - complete - canceled description: The status of the invoice. tracking_number: type: string description: The tracking number of the fulfillment. items: type: array items: $ref: >- #/components/schemas/fulfillmentItemCreateRequestForFulfillmentPost description: Information of all fulfillment items. required: - order_line_item_id - fulfillment_date - quantity fulfillmentPatchRequest: type: object title: FulfillmentPatchRequest description: '' nullable: false additionalProperties: false properties: order_line_item_id: type: string description: The unique identifier of the associated order line item. target_date: type: string format: date description: >- All order line items associated with this fulfillment that were unbilled on or before this date are included in future bill runs. example: '2022-01-01' carrier: type: string description: The name of the shipping carrier for this fulfillment. custom_fields: $ref: '#/components/schemas/customFields' description: type: string description: >- An arbitrary string attached to the object. Often useful for displaying to users. revenue: allOf: - $ref: '#/components/schemas/revenue' external_id: type: string description: An external identifier for the fulfillment. fulfillment_date: type: string format: date description: The date of the fulfillment. example: '2023-01-01' location: type: string description: The fulfillment location of the fulfillment fulfillment_system: type: string description: The fulfillment system for the fulfillment type: type: string enum: - delivery - return description: The type of fulfillment. quantity: type: number description: The number of units of this item. state: type: string enum: - accepted - booked - sent_to_billing - complete - canceled description: The status of the invoice. tracking_number: type: string description: The tracking number of the fulfillment. fulfillmentItemCreateRequestForFulfillmentPost: type: object title: FulfillmentItemCreateRequestForFulfillmentPost description: '' nullable: false additionalProperties: false properties: description: type: string description: >- An arbitrary string attached to the object. Often useful for displaying to users. fulfillment_item_number: type: string description: Human-readable identifier for the object. It can be user-supplied. custom_fields: $ref: '#/components/schemas/customFields' fulfillmentItemCreateRequest: type: object title: FulfillmentItemCreateRequest description: '' additionalProperties: false properties: description: type: string description: >- An arbitrary string attached to the object. Often useful for displaying to users. fulfillment_item_number: type: string description: Human-readable identifier for the object. It can be user-supplied. custom_fields: $ref: '#/components/schemas/customFields' fulfillment_number: type: string description: Human-readable identifier for the object. It can be user-supplied. required: - fulfillment_number fulfillmentItemCreateBulkRequest: type: object title: FulfillmentItemCreateBulkRequest description: '' nullable: false additionalProperties: false properties: data: type: array items: $ref: '#/components/schemas/fulfillmentItemCreateRequest' fulfillmentItemBulkResponse: type: object title: FulfillmentItemBulkResponse description: '' nullable: false additionalProperties: false properties: id: type: string description: Human-readable identifier of the fulfillment id. fulfillmentItemCreateBulkResponse: type: object title: FulfillmentItemCreateBulkResponse description: '' nullable: false additionalProperties: false properties: data: type: array items: $ref: '#/components/schemas/fulfillmentItemBulkResponse' fulfillmentItem: type: object title: FulfillmentItem description: '' nullable: false additionalProperties: false properties: id: type: string readOnly: true description: Unique identifier for the object. updated_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who last updated the object updated_time: type: string format: date-time readOnly: true description: >- The date and time when the object was last updated in ISO 8601 UTC format. created_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who created the object created_time: type: string format: date-time readOnly: true description: >- The date and time when the object was created in ISO 8601 UTC format. custom_fields: type: object title: CustomFields description: >- Set of user-defined fields associated with this object. Useful for storing additional information about the object in a structured format. x-extra-field-annotation: '@JsonAdapter(CustomFieldAdapter.class)' additionalProperties: true custom_objects: oneOf: - $ref: '#/components/schemas/listCustomObjectResponse' - $ref: '#/components/schemas/custom_object' readOnly: true description: The custom objects associated with a Zuora standard object. description: type: string description: >- An arbitrary string attached to the object. Often useful for displaying to users. fulfillment_item_number: type: string description: Human-readable identifier for the object. It can be user-supplied. fulfillment_id: type: string description: Human-readable identifier for the object. It can be user-supplied. filfillmentItemListResponse: type: object title: FilfillmentItemListResponse description: '' nullable: false additionalProperties: false properties: next_page: type: string nullable: true data: type: array items: $ref: '#/components/schemas/fulfillmentItem' fulfillmentItemPatchRequest: type: object title: FulfillmentItemPatchRequest description: '' nullable: false additionalProperties: false properties: description: type: string description: >- An arbitrary string attached to the object. Often useful for displaying to users. fulfillment_item_number: type: string description: Human-readable identifier for the object. It can be user-supplied. custom_fields: $ref: '#/components/schemas/customFields' paymentScheduleItemPaymentOption: type: object title: PaymentScheduleItemPaymentOption description: '' nullable: false additionalProperties: false properties: detail: type: object additionalProperties: type: string example: key: value type: type: string paymentScheduleItemPayments: type: object title: PaymentScheduleItemPayments description: '' nullable: false additionalProperties: false properties: id: type: string description: Unique identifier of the payment schedule item. paymentScheduleItemCreateRequest: type: object title: PaymentScheduleItemCreateRequest description: '' nullable: false additionalProperties: false properties: payment_schedule_id: type: string description: ID of a payment schedule. payment_schedule_number: type: string description: Number of the payment schedule. account_id: type: string description: >- Unique identifier of the customer account the payment schedule belongs to. example: 8ad093f27d6eee80017d6effd7a66759 amount: type: number description: The amount to be collected by this payment schedule item. currency: type: string description: >- Currency of the payment schedule. The default value is the account's default currency. This field will be ignored when items is specified. example: USD description: type: string description: >- An arbitrary string attached to the object. Often useful for displaying to users. example: description of payment schedule item payment_gateway_id: type: string description: >- ID of the payment gateway used to collect payments. The default value is the account's default payment gateway ID. If no payment gateway ID is found on the customer account level, the default value will be the tenant's default payment gateway ID. This field will be ignored when `items` is specified. example: 8ad093f27d6eee80017d6effd7a66759 payment_method_id: type: string description: >- ID of the payment method. The default value is the account's default payment method ID. This field will be ignored when `items` is specified. example: 8a95b1946b6aeac8718c32aab8c395f scheduled_date: type: string format: date description: The scheduled date of collection. example: '2022-01-01' run_hour: type: integer minimum: 0 maximum: 23 description: >- At which hour in the day in the tenant's timezone this payment will be collected. Available values:[0,1,2,~,22,23]. If the time difference between your tenant’s timezone and the timezone where Zuora servers are located is not in full hours, for example, 2.5 hours, the payment schedule items will be triggered half an hour later than your scheduled time. The default value is 0. If the payment run_hour and scheduled_date are backdated, the system will collect the payment when the next run_hour occurs. custom_fields: $ref: '#/components/schemas/customFields' payment_options: type: array items: $ref: '#/components/schemas/paymentScheduleItemPaymentOption' description: >- Container for the payment options, which describe the transactional level rules for processing payments. Currently, only the `gateway_options` type is supported. Payment schedule `payment_options` take precedence over payment schedule item `payment_options`. required: - payment_schedule_id paymentScheduleItemLink: type: object title: PaymentScheduleItemLink description: '' nullable: false additionalProperties: false properties: id: type: string description: Unique identifier of the payment schedule item. paymentScheduleItemUnlink: type: object title: PaymentScheduleItemUnlink description: '' nullable: false additionalProperties: false properties: id: type: string description: Unique identifier of the payment schedule item. paymentScheduleItemPatch: type: object title: PaymentScheduleItemPatch description: '' nullable: false additionalProperties: false properties: payment_schedule_id: type: string description: ID of the payment schedule. payment_schedule_number: type: string description: Number of the payment schedule. amount: type: number description: The amount to be collected by this payment schedule item. currency: type: string description: >- Currency of the payment schedule. The default value is the account's default currency. This field will be ignored when items is specified. example: USD description: type: string description: >- An arbitrary string attached to the object. Often useful for displaying to users. example: description of payment schedule item payment_gateway_id: type: string description: >- ID of the payment gateway used to collect payments. The default value is the account's default payment gateway ID. If no payment gateway ID is found on the customer account level, the default value will be the tenant's default payment gateway ID. This field will be ignored when `items` is specified. example: 8ad093f27d6eee80017d6effd7a66759 payment_method_id: type: string description: >- ID of the payment method. The default value is the account's default payment method ID. This field will be ignored when `items` is specified. example: 8a95b1946b6aeac8718c32aab8c395f scheduled_date: type: string format: date description: The scheduled date of collection. example: '2022-01-01' run_hour: type: integer minimum: 0 maximum: 23 description: >- At which hour in the day in the tenant's timezone this payment will be collected. Available values:[0,1,2,~,22,23]. If the time difference between your tenant’s timezone and the timezone where Zuora servers are located is not in full hours, for example, 2.5 hours, the payment schedule items will be triggered half an hour later than your scheduled time. The default value is 0. If the payment run_hour and scheduled_date are backdated, the system will collect the payment when the next run_hour occurs. custom_fields: $ref: '#/components/schemas/customFields' payment_options: type: array items: $ref: '#/components/schemas/paymentScheduleItemPaymentOption' description: >- Container for the payment options, which describe the transactional level rules for processing payments. Currently, only the `gateway_options` type is supported. Payment schedule `payment_options` take precedence over payment schedule item `payment_options`. link: type: array items: $ref: '#/components/schemas/paymentScheduleItemLink' unlink: type: array items: $ref: '#/components/schemas/paymentScheduleItemUnlink' paymentScheduleItemRetry: type: object title: PaymentScheduleItemRetry description: '' nullable: false additionalProperties: false properties: payment_gateway_id: type: string description: >- ID of the payment gateway used to collect payments. The default value is the account's default payment gateway ID. If no payment gateway ID is found on the customer account level, the default value will be the tenant's default payment gateway ID. This field will be ignored when `items` is specified. example: 8ad093f27d6eee80017d6effd7a66759 payment_method_id: type: string description: >- ID of the payment method. The default value is the account's default payment method ID. This field will be ignored when `items` is specified. example: 8a95b1946b6aeac8718c32aab8c395f paymentScheduleItemRequest: type: object title: PaymentScheduleItemRequest description: '' nullable: false additionalProperties: false properties: amount: type: number description: The amount to be collected by this payment schedule item. currency: type: string description: >- Three-letter ISO currency code. Once the currency is set for an account, it cannot be updated. example: USD description: type: string description: >- An arbitrary string attached to the object. Often useful for displaying to users. example: description of test account gateway_id: type: string example: 8ad093f27d6eee80017d6effd7a66759 payment_method_id: type: string description: Identifier of the payment method on the customer account. example: 8a95b1946b6aeac8718c32aab8c395f run_hour: type: integer minimum: 0 maximum: 23 description: >- At which hour in the day in the tenant's timezone this payment will be collected. Available values:[0,1,2,~,22,23]. If the time difference between your tenant’s timezone and the timezone where Zuora servers are located is not in full hours, for example, 2.5 hours, the payment schedule items will be triggered half an hour later than your scheduled time. The default value is `0`. If the payment `run_hour` and `scheduled_date` are backdated, the system will collect the payment when the next `run_hour` occurs. scheduled_date: type: string format: date description: The scheduled date of the payment collection. example: '2022-01-01' custom_fields: $ref: '#/components/schemas/customFields' paymentSchedulePaymentsItem: type: object title: PaymentSchedulePaymentsItem description: '' nullable: false additionalProperties: false properties: id: type: string description: Unique identifier of the payment schedule item. paymentSchedulePaymentOptionRequest: type: object title: PaymentSchedulePaymentOptionRequest description: '' nullable: false additionalProperties: false properties: detail: type: object additionalProperties: type: string example: key: value type: type: boolean paymentScheduleBillingDocumentResponse: type: object title: PaymentScheduleBillingDocumentResponse description: '' nullable: false additionalProperties: false properties: id: type: string description: Unique identifier of an invoice or debit memo billing document. type: type: string enum: - invoice - debit_memo description: The type of billing document. The default is `invoice`. paymentScheduleBillingDocumentRequest: type: object title: PaymentScheduleBillingDocumentRequest description: '' nullable: false additionalProperties: false properties: id: type: string description: Unique identifier of an invoice or debit memo billing document. type: type: string enum: - invoice - debit_memo description: The type of billing document. The default is `invoice`. billing_document_number: type: string description: Document number of an invoice or debit memo billing document. paymentScheduleItem: type: object title: PaymentScheduleItem description: '' nullable: false additionalProperties: false properties: id: type: string readOnly: true description: Unique identifier for the object. updated_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who last updated the object updated_time: type: string format: date-time readOnly: true description: >- The date and time when the object was last updated in ISO 8601 UTC format. created_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who created the object created_time: type: string format: date-time readOnly: true description: >- The date and time when the object was created in ISO 8601 UTC format. custom_fields: type: object title: CustomFields description: >- Set of user-defined fields associated with this object. Useful for storing additional information about the object in a structured format. x-extra-field-annotation: '@JsonAdapter(CustomFieldAdapter.class)' additionalProperties: true custom_objects: oneOf: - $ref: '#/components/schemas/listCustomObjectResponse' - $ref: '#/components/schemas/custom_object' readOnly: true description: The custom objects associated with a Zuora standard object. account_id: type: string description: >- Unique identifier of the customer account the payment schedule belongs to. example: 8ad093f27d6eee80017d6effd7a66759 amount: type: number description: The amount to be collected by this payment schedule item. balance: type: number description: The remaining balance of payment schedule item. billing_document: allOf: - $ref: '#/components/schemas/paymentScheduleBillingDocumentResponse' description: >- The billing document with which the payment schedule is associated. If you have the Standalone Payment feature enabled, you can leave this field blank and set standalone to true to create standalone payments. You can also choose to create unapplied payments by leaving this object blank and setting standalone to false. If Standalone Payment is not enabled, leaving this object unspecified will create unapplied payments. cancellation_reason: type: string description: The reason for the cancellation of payment schedule item. currency: type: string description: >- Currency of the payment schedule. The default value is the account's default currency. This field will be ignored when items is specified. example: USD description: type: string description: >- An arbitrary string attached to the object. Often useful for displaying to users. example: description of payment schedule item payment_schedule_item_number: type: string description: Number of the payment schedule item. payment_gateway_id: type: string description: >- ID of the payment gateway used to collect payments. The default value is the account's default payment gateway ID. If no payment gateway ID is found on the customer account level, the default value will be the tenant's default payment gateway ID. This field will be ignored when `items` is specified. example: 8ad093f27d6eee80017d6effd7a66759 payment_method_id: type: string description: >- ID of the payment method. The default value is the account's default payment method ID. This field will be ignored when `items` is specified. example: 8a95b1946b6aeac8718c32aab8c395f payment_option_id: type: string description: ID of the payment option. payment_schedule_id: type: string description: ID of the payment schedule. payment_schedule_number: type: string description: Number of the payment schedule. payments: type: array items: $ref: '#/components/schemas/paymentScheduleItemPayments' run_hour: type: integer minimum: 0 maximum: 23 description: >- At which hour in the day in the tenant's timezone this payment will be collected. Available values:[0,1,2,~,22,23]. If the time difference between your tenant’s timezone and the timezone where Zuora servers are located is not in full hours, for example, 2.5 hours, the payment schedule items will be triggered half an hour later than your scheduled time. The default value is 0. If the payment run_hour and scheduled_date are backdated, the system will collect the payment when the next run_hour occurs. scheduled_date: type: string format: date description: The scheduled date of collection. example: '2022-01-01' standalone: type: boolean description: >- Indicates whether the payments created by the payment schedule are standalone payments or not. When setting to true, standalone payments will be created. When setting to false, you can either specify a billing document, or not specifying any billing documents. In the later case, unapplied payments will be created. If set to null, standalone payments will be created. Note: This parameter is only available if standalone payments are enabled in your tenant. Do not include this parameter if standalone payment have not been enabled in your tenant. If standalone payments are enabled, the default value is true. state: type: string enum: - pending - canceled - complete - error description: >- The status of the payment schedule item. active: there are unprocessed payment schedule items. canceled: the payment schedule has been canceled. complete: the payment schedule is complete and all items have been processed. error_message: type: string description: >- An error message indicating why payment collection failed for this payment schedule item. payment: allOf: - $ref: '#/components/schemas/payment' readOnly: true description: List of customer payments. payment_schedule: allOf: - $ref: '#/components/schemas/paymentSchedule' readOnly: true description: Payment schedule record. paymentScheduleCreateRequest: type: object title: PaymentScheduleCreateRequest description: '' nullable: false additionalProperties: false properties: account_id: type: string description: >- Unique identifier of the customer account the payment schedule belongs to. account_number: type: string description: >- Account number of the customer account the payment schedule belongs to. billing_document: allOf: - $ref: '#/components/schemas/paymentScheduleBillingDocumentRequest' description: >- The billing document with which the payment schedule is associated. Note: This field is optional. If you have the Standalone Payment feature enabled, you can leave this field blank and set standalone to true to create standalone payments. You can also choose to create unapplied payments by leaving this object blank and setting standalone to false. If Standalone Payment is not enabled, leaving this object unspecified will create unapplied payments. currency: type: string description: >- Currency of the payment schedule. Note: This field is optional. The default value is the account's default currency. This field will be ignored when items is specified. example: USD description: type: string description: >- An arbitrary string attached to the object. Often useful for displaying to users. example: description of test account items: type: array items: $ref: '#/components/schemas/paymentScheduleItemRequest' description: Container for payment schedule items. payment_gateway_id: type: string description: >- ID of the payment gateway used to collect payments. Note: This field is optional. The default value is the account's default payment gateway ID. If no payment gateway ID is found on the customer account level, the default value will be the tenant's default payment gateway ID. This field will be ignored when items is specified. example: 8ad093f27d6eee80017d6effd7a66759 payment_gateway_number: type: string description: >- The payment gateway number of the payment gateway used to collect scheduled payments. payment_method_number: type: string description: >- The payment method number of the payment method to be used to collect payments. payment_method_id: type: string description: >- ID of the payment method. Note: This field is optional. The default value is the account's default payment method ID. This field will be ignored when items is specified. example: 8a95b1946b6aeac8718c32aab8c395f payment_schedule_number: type: string description: Number of the payment schedule. payment_options: type: array items: $ref: '#/components/schemas/paymentSchedulePaymentOptionRequest' description: >- Container for the payment options, which describe the transactional level rules for processing payments. Currently, only the gateway_options type is supported. Payment schedule payment_options take precedence over payment schedule item payment_options. standalone: type: boolean description: >- Indicates whether the payments created by the payment schedule are standalone payments or not. When setting to `true`, standalone payments will be created. When setting to `false`, you can either specify a billing document, or not specifying any billing documents. In the latter case, unapplied payments will be created. If set to `null`, standalone payments will be created. **Note**: This parameter is only available if standalone payments are enabled in your tenant. The default value is `true` if standalone payments are enabled in your tenant. start_date: type: string format: date description: >- The date of the first scheduled payment collection. Note: This parameter is required when `items` is not specified. This parameter will be ignored when `items` is specified. example: '2023-01-01' prepayment: type: boolean description: >- Indicates whether the payments created by the payment schedule will be used as reserved payments. This field will only be available if the prepaid cash drawdown permission is enabled. See Prepaid Cash with Drawdown for more information. period: enum: - week - month - biweekly description: Unit in which term duration is defined. One of week or month. amount: type: number description: The amount of each payment schedule item in the payment schedule. total_amount: type: number description: The total amount to be collected by the payment schedule. number_of_payments: type: integer description: >- The number of payment schedule items to be created for this payment schedule. custom_fields: $ref: '#/components/schemas/customFields' paymentSchedule: type: object title: PaymentSchedule description: '' nullable: false additionalProperties: false properties: id: type: string readOnly: true description: Unique identifier for the object. updated_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who last updated the object updated_time: type: string format: date-time readOnly: true description: >- The date and time when the object was last updated in ISO 8601 UTC format. created_by_id: type: string readOnly: true description: Unique identifier of the Zuora user who created the object created_time: type: string format: date-time readOnly: true description: >- The date and time when the object was created in ISO 8601 UTC format. custom_fields: type: object title: CustomFields description: >- Set of user-defined fields associated with this object. Useful for storing additional information about the object in a structured format. x-extra-field-annotation: '@JsonAdapter(CustomFieldAdapter.class)' additionalProperties: true custom_objects: oneOf: - $ref: '#/components/schemas/listCustomObjectResponse' - $ref: '#/components/schemas/custom_object' readOnly: true description: The custom objects associated with a Zuora standard object. account_id: type: string description: >- Unique identifier of the customer account the payment schedule belongs to. account_number: type: string description: >- Account number of the customer account the payment schedule belongs to. amount: type: number description: The amount of each payment schedule item in the payment schedule. period: enum: - week - month - biweekly description: Unit in which term duration is defined. One of week or month. billing_document: allOf: - $ref: '#/components/schemas/paymentScheduleBillingDocumentResponse' description: >- The billing document with which the payment schedule is associated. Note: This field is optional. If you have the Standalone Payment feature enabled, you can leave this field blank and set standalone to true to create standalone payments. You can also choose to create unapplied payments by leaving this object blank and setting standalone to false. If Standalone Payment is not enabled, leaving this object unspecified will create unapplied payments. currency: type: string description: >- Currency of the payment schedule. Note: This field is optional. The default value is the account's default currency. This field will be ignored when items is specified. example: USD description: type: string description: >- An arbitrary string attached to the object. Often useful for displaying to users. example: description of test account items: type: array items: $ref: '#/components/schemas/paymentScheduleItem' number_of_payments: type: integer description: >- The number of payment schedule items to be created for this payment schedule. payment_gateway_id: type: string description: >- ID of the payment gateway used to collect payments. Note: This field is optional. The default value is the account's default payment gateway ID. If no payment gateway ID is found on the customer account level, the default value will be the tenant's default payment gateway ID. This field will be ignored when items is specified. example: 8ad093f27d6eee80017d6effd7a66759 payment_method_id: type: string description: >- ID of the payment method. Note: This field is optional. The default value is the account's default payment method ID. This field will be ignored when items is specified. example: 8a95b1946b6aeac8718c32aab8c395f payment_schedule_number: type: string description: Number of the payment schedule. run_hour: type: integer minimum: 0 maximum: 23 description: >- At which hour in the day in the tenant's timezone this payment will be collected. Available values:[0,1,2,~,22,23]. If the time difference between your tenant’s timezone and the timezone where Zuora servers are located is not in full hours, for example, 2.5 hours, the payment schedule items will be triggered half an hour later than your scheduled time. The default value is 0. If the payment run_hour and scheduled_date are backdated, the system will collect the payment when the next run_hour occurs. standalone: type: boolean description: >- Indicates whether the payments created by the payment schedule are standalone payments or not. When setting to `true`, standalone payments will be created. When setting to `false`, you can either specify a billing document, or not specifying any billing documents. In the latter case, unapplied payments will be created. If set to `null`, standalone payments will be created. **Note**: This parameter is only available if standalone payments are enabled in your tenant. The default value is `true` if standalone payments are enabled in your tenant. start_date: type: string format: date description: >- The date of the first scheduled payment collection. Note: This parameter is required when `items` is not specified. This parameter will be ignored when `items` is specified. example: '2023-01-01' total_amount: type: number description: The total amount to be collected by the payment schedule. custom: type: boolean description: >- If it is set to `true`, the payment schedule is a custom payment schedule. next_payment_date: type: string format: date description: The date of the next scheduled payment. example: '2022-01-01' recent_payment_date: type: string format: date description: The date of the most recent scheduled payment. example: '2022-01-01' state: type: string enum: - active - canceled - complete description: >- The status of the payment schedule. active: there are unprocessed payment schedule items. canceled: the payment schedule has been canceled. complete: the payment schedule is complete and all items have been processed. total_payments_errored: type: integer description: The total number of failed payments. total_payments_processed: type: integer description: The total number of payments processed. payment_options: type: array items: $ref: '#/components/schemas/paymentSchedulePaymentOptionRequest' description: >- Container for the payment options, which describe the transactional level rules for processing payments. Currently, only the gateway_options type is supported. Payment schedule payment_options take precedence over payment schedule item payment_options. prepayment: type: boolean description: >- Indicates whether the payments created by the payment schedule will be used as reserved payments. This field will only be available if the prepaid cash drawdown permission is enabled. See Prepaid Cash with Drawdown for more information. paymentSchedulePatchRequest: type: object title: PaymentSchedulePatchRequest description: '' nullable: false additionalProperties: false properties: currency: type: string description: >- Currency of the payment schedule. Note: This field is optional. The default value is the account's default currency. This field will be ignored when items is specified. example: USD number_of_payments: type: integer description: >- The number of payment schedule items to be created for this payment schedule. payment_gateway_id: type: string description: >- ID of the payment gateway used to collect payments. Note: This field is optional. The default value is the account's default payment gateway ID. If no payment gateway ID is found on the customer account level, the default value will be the tenant's default payment gateway ID. This field will be ignored when items is specified. example: 8ad093f27d6eee80017d6effd7a66759 payment_method_id: type: string description: >- ID of the payment method. Note: This field is optional. The default value is the account's default payment method ID. This field will be ignored when items is specified. example: 8a95b1946b6aeac8718c32aab8c395f payment_method_number: type: string description: >- The payment method number of the payment method to be used to collect payments. run_hour: type: integer minimum: 0 maximum: 23 description: >- At which hour in the day in the tenant's timezone this payment will be collected. Available values:[0,1,2,~,22,23]. If the time difference between your tenant’s timezone and the timezone where Zuora servers are located is not in full hours, for example, 2.5 hours, the payment schedule items will be triggered half an hour later than your scheduled time. The default value is `0`. If the payment `run_hour` and `scheduled_date` are backdated, the system will collect the payment when the next `run_hour` occurs. custom_fields: $ref: '#/components/schemas/customFields' payment_options: type: array items: $ref: '#/components/schemas/paymentSchedulePaymentOptionRequest' description: >- Container for the payment options, which describe the transactional level rules for processing payments. Currently, only the gateway_options type is supported. Payment schedule payment_options take precedence over payment schedule item payment_options. start_date: type: string format: date description: >- The date of the first scheduled payment collection. Note: This parameter is required when `items` is not specified. This parameter will be ignored when `items` is specified. example: '2023-01-01' amount: type: number description: The amount of each payment schedule item in the payment schedule. period: enum: - week - month - biweekly description: Unit in which term duration is defined. One of week or month. paymentScheduleCancel: type: object title: PaymentScheduleCancel description: '' nullable: false additionalProperties: false properties: cancel_date: type: string format: date description: The date on which the payment schdule is canceled. example: '2022-09-01' required: - cancel_date paymentScheduleItemRetryBulk: type: object title: PaymentScheduleItemRetryBulk description: '' nullable: false additionalProperties: false properties: id: type: string payment_gateway_id: type: string description: >- ID of the payment gateway used to collect payments. The default value is the account's default payment gateway ID. If no payment gateway ID is found on the customer account level, the default value will be the tenant's default payment gateway ID. This field will be ignored when `items` is specified. example: 8ad093f27d6eee80017d6effd7a66759 payment_method_id: type: string description: >- ID of the payment method. The default value is the account's default payment method ID. This field will be ignored when `items` is specified. example: 8a95b1946b6aeac8718c32aab8c395f prepaidBalance: type: object title: PrepaidBalance description: '' nullable: false additionalProperties: false properties: prepaid_UOM: type: string description: Unit of measure for the prepaid balance. start_date: type: string format: date description: Start date of the fund effective period. example: '2022-01-01' end_date: type: string format: date description: End date of the fund effective period. example: '2023-01-01' total_balance: type: number description: 'The funded balance, which is the total units of the fund. ' remaining_balance: type: number description: >- Remaining balance on the fund, which is the remaining units of the fund. transactions: type: array items: $ref: '#/components/schemas/prepaidBalanceTransaction' readOnly: true description: An array of prepaid balance transactions prepaidBalanceTransaction: type: object title: PrepaidBalanceTransaction description: '' nullable: false additionalProperties: false properties: transaction_date: type: string description: Date on which the transaction occurs. type: type: string enum: - prepayment - drawdown description: >- An action that increases or decreases its associated prepaid balance. quantity: type: number description: Quantity of the prepaid balance transaction. paths: /accounts: get: operationId: getAccounts summary: List accounts tags: - Accounts description: >- Returns a dictionary with a data property that contains an array of accounts, starting after the cursor, if used. Each entry in the array is a separate account object. If no more accounts are available, the resulting array will be empty. This request should never return an error. parameters: - in: query name: cursor required: false schema: type: string x-java-sdk-legacy-param: true 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 x-java-sdk-legacy-param: true items: type: string description: >- Allows you to expand responses by including related object information in a single call. See the [Expand responses](https://developer.zuora.com/quickstart-api/tutorial/expand-responses/) section of the Quickstart API Tutorials for detailed instructions. - in: query name: filter[] required: false schema: type: array x-java-sdk-legacy-param: true items: type: string description: >- A case-sensitive filter on the list. See the [Filter lists](https://developer.zuora.com/quickstart-api/tutorial/filter-lists/) section of the Quickstart API Tutorials for detailed instructions. - in: query name: sort[] required: false schema: type: array x-java-sdk-legacy-param: false items: type: string description: >- A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `account_number.asc`) or descending (e.g. `account_number.desc`). You cannot sort on properties that are arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. - in: query name: page_size required: false schema: type: integer x-java-sdk-legacy-param: false minimum: 1 maximum: 99 description: >- The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `auto_pay`, `account_number`, `bill_to_id`, `sold_to_id`, `billing_document_settings`, `communication_profile_id`, `crm_id`, `sales_rep`, `parent_account_id`, `payment_gateway`, `payment_terms`, `remaining_credit_memo_balance`, `remaining_debit_memo_balance`, `remaining_invoice_balance`, `remaining_payment_balance`, `sequence_set_id`, `tax_certificate`, `batch`, `tax_identifier`, `bill_cycle_day`, `description`, `name`, `currency`, `default_payment_method_id`, `enabled`
- in: query name: subscriptions.fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `subscription_number`, `state`, `account_id`, `invoice_owner_account_id`, `auto_renew`, `version`, `initial_term`, `current_term`, `renewal_term`, `start_date`, `end_date`, `description`, `contract_effective`, `service_activation`, `customer_acceptance`, `invoice_separately`, `latest_version`, `payment_terms`, `billing_document_settings`, `bill_to_id`, `sold_to_id`, `contracted_mrr`, `order_number`
- in: query name: subscription_plans.fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `name`, `plan_id`, `subscription_id`, `product_id`
- in: query name: subscription_items.fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `start_date`, `end_date`, `charge_model`, `charge_type`, `tiers`, `subscription_item_number`, `name`, `description`, `charged_through_date`, `recurring`, `price_id`, `start_event`, `tax_code`, `tax_inclusive`, `unit_of_measure`, `quantity`, `price_base_interval`, `overage`, `subscription_plan_id`, `tiers_mode`, `processed_through_date`, `active`, `state`, `unit_amount`, `amount`, `discount_amount`, `discount_percent`
- in: query name: invoice_owner_account.fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `auto_pay`, `account_number`, `bill_to_id`, `sold_to_id`, `billing_document_settings`, `communication_profile_id`, `crm_id`, `sales_rep`, `parent_account_id`, `payment_gateway`, `payment_terms`, `remaining_credit_memo_balance`, `remaining_debit_memo_balance`, `remaining_invoice_balance`, `remaining_payment_balance`, `sequence_set_id`, `tax_certificate`, `batch`, `tax_identifier`, `bill_cycle_day`, `description`, `name`, `currency`, `default_payment_method_id`, `enabled`
- in: query name: plan.fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `start_date`, `end_date`, `name`, `active`, `description`, `plan_number`, `product_id`, `active_currencies`
- in: query name: payment_methods.fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `type`, `account_id`, `bank_identification_number`, `device_session_id`, `ip_address`, `maximum_payment_attempts`, `payment_retry_interval`, `state`, `use_default_retry_rule`, `existing_mandate`, `last_failed_sale_transaction_time`, `last_transaction_time`, `last_transaction_status`, `number_of_consecutive_failures`, `total_number_of_processed_payments`, `total_number_of_error_payments`, `billing_details`, `card`, `apple_pay`, `google_pay`, `ach_debit`, `cc_ref`, `paypal_adaptive`, `paypal_express_native`, `paypal_express`, `sepa_debit`, `betalings_debit`, `autogiro_debit`, `bacs_debit`, `au_becs_debit`, `nz_becs_debit`, `pad_debit`
- in: query name: payments.fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `payment_number`, `payment_date`, `gateway_id`, `payment_method_id`, `payout_id`, `reference_id`, `second_reference_id`, `statement_descriptor_phone`, `state`, `statement_descriptor`, `account_id`, `amount`, `amount_applied`, `amount_refunded`, `remaining_balance`, `currency`, `description`, `authorization_id`, `external`, `gateway_order_id`, `gateway_reconciliation_status`, `gateway_reconciliation_reason`, `gateway_response`, `gateway_response_code`, `gateway_state`, `state_transitions`, `gateway_state_transitions`
- in: query name: billing_documents.fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `account_id`, `balance`, `description`, `state`, `tax`
- in: query name: billing_document_items.fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `price_id`, `discount_item`, `deferred_revenue_account`, `description`, `name`, `quantity`, `recognized_revenue_account`, `service_end`, `service_start`, `accounts_receivable_account`, `subscription_id`, `subscription_item_id`, `tax`, `tax_inclusive`, `unit_amount`
- in: query name: bill_to.fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `account_id`, `address`, `home_phone`, `first_name`, `last_name`, `email`, `work_email`, `nickname`, `other_phone`, `work_phone`, `mobile_phone`, `tax_region`, `other_phone_type`, `fax`
- in: query name: sold_to.fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `account_id`, `address`, `home_phone`, `first_name`, `last_name`, `email`, `work_email`, `nickname`, `other_phone`, `work_phone`, `mobile_phone`, `tax_region`, `other_phone_type`, `fax`
- in: query name: default_payment_method.fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `type`, `account_id`, `bank_identification_number`, `device_session_id`, `ip_address`, `maximum_payment_attempts`, `payment_retry_interval`, `state`, `use_default_retry_rule`, `existing_mandate`, `last_failed_sale_transaction_time`, `last_transaction_time`, `last_transaction_status`, `number_of_consecutive_failures`, `total_number_of_processed_payments`, `total_number_of_error_payments`, `billing_details`, `card`, `apple_pay`, `google_pay`, `ach_debit`, `cc_ref`, `paypal_adaptive`, `paypal_express_native`, `paypal_express`, `sepa_debit`, `betalings_debit`, `autogiro_debit`, `bacs_debit`, `au_becs_debit`, `nz_becs_debit`, `pad_debit`
- in: query name: usage_records.fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `account_id`, `account_number`, `subscription_item_id`, `subscription_item_number`, `subscription_id`, `subscription_number`, `unit_of_measure`, `description`, `end_time`, `state`, `start_time`, `quantity`
- in: query name: invoices.fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `state`, `balance`, `due_date`, `invoice_number`, `posted_by_id`, `state_transitions`, `description`, `account_id`, `total`, `subtotal`, `tax`, `paid`, `past_due`, `document_date`, `amount_paid`, `amount_refunded`, `payment_terms`, `bill_to_id`, `sold_to_id`, `billing_document_settings`
- in: query name: credit_memos.fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `credit_memo_number`, `state_transitions`, `description`, `account_id`, `total`, `subtotal`, `tax`, `document_date`, `exclude_from_auto_apply_rules`, `posted_by_id`, `state`, `balance`, `invoice_id`, `reason_code`, `amount_refunded`, `bill_to_id`, `billing_document_settings`
- in: query name: debit_memos.fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `balance`, `due_date`, `debit_memo_number`, `state_transitions`, `description`, `account_id`, `total`, `subtotal`, `tax`, `document_date`, `posted_by_id`, `state`, `reason_code`, `paid`, `past_due`, `billing_document_settings`, `payment_terms`, `bill_to_id`, `invoice_id`
- in: query name: prepaid_balance.fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `prepaid_UOM`, `start_date`, `end_date`, `total_balance`, `remaining_balance`
- in: query name: transactions.fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `transaction_date`, `type`, `quantity`
- $ref: '#/components/parameters/zuora-track-id' - $ref: '#/components/parameters/zuora-entity-id' - $ref: '#/components/parameters/idempotency-key' - $ref: '#/components/parameters/accept-encoding' - $ref: '#/components/parameters/content-encoding' x-operation-type: list x-is-list-operation: true x-code-samples: - lang: Curl label: cURL source: > curl --request GET --url 'https://rest.apisandbox.zuora.com/v2/accounts' --header 'Authorization: Bearer d8a7f4d2a5ef4c3eba8618cf99593e26' --header 'Content-Type: application/json' - lang: Java label: Java source: >- ListAccountResponse accountListResponse = zuoraClient.accounts().getAccounts(null,Collections.singletonList("bill_to"),null); System.out.println(accountListResponse); - lang: JavaScript label: Node source: |- const accountsResponse = await zuoraClient.accounts.getAccounts({ filter: [ 'batch.EQ:Batch1', ], expand: [ 'subscriptions', ] }) console.log(accountsResponse); x-group-parameters: true responses: '200': description: Default Response content: application/json: schema: $ref: '#/components/schemas/listAccountResponse' example: next_page: >- W3sib3JkZXJCeSI6eyJmaWVsZCI6IlVwZGF0ZWREYXRlIiwib3JkZXIiOiJERVNDIn0sInZhbHVlIjoiMjAyMi0xMi0yMFQxMjoyODo1NC0wODowMCJ9LHsib3JkZXJCeSI6eyJmaWVsZCI6IklkIiwib3JkZXIiOiJERVNDIn0sInZhbHVlIjoiMmM5MmMwZjk2YWJjMTdkZTAxNmFiZDYyYmQwYzU4NTQifV0= data: - id: 8ad08ccf8437067601843a7af4e64rq3 updated_by_id: 2c92c0946a6dffc0016a7faab604299b updated_time: '2022-08-03T13:07:53-07:00' created_by_id: 2c92c0946a6dffc0016a7faab604299b created_time: '2022-08-03T13:07:53-07:00' custom_fields: field__c: custom field value account_number: RC-0002048901234 billing_document_settings: email_documents: true print_documents: false invoice_template_id: 8f64d4d754739d85d0346e00ef77e50d additional_email: - jane.doe@gmail.com - ' james.lawerence@gmail.com' batch: Batch1 bill_cycle_day: 0 name: Amy Lawrence Account payment_terms: Due Upon Receipt auto_pay: false currency: USD enabled: true remaining_debit_memo_balance: 0 remaining_invoice_balance: 0 remaining_credit_memo_balance: 0 remaining_payment_balance: 0 bill_to_id: 8ad085518262bc17018265525ebb3697 sold_to_id: 8ad085518262bc17018265525ec43699 - id: 8ad08ccf8437067601843a7af4e64rq3 updated_by_id: 2c92c0946a6dffc0016a7faab604299b updated_time: '2022-08-03T13:07:53-07:00' created_by_id: 2c92c0946a6dffc0016a7faab604299b created_time: '2022-08-03T13:07:53-07:00' custom_fields: field__c: custom field value account_number: RC-0002048901234 billing_document_settings: email_documents: true print_documents: false invoice_template_id: 8f64d4d754739d85d0346e00ef77e50d additional_email: - jane.doe@gmail.com - ' james.lawerence@gmail.com' batch: Batch1 bill_cycle_day: 0 name: Amy Lawrence Account payment_terms: Due Upon Receipt auto_pay: false currency: USD enabled: true remaining_debit_memo_balance: 0 remaining_invoice_balance: 0 remaining_credit_memo_balance: 0 remaining_payment_balance: 0 bill_to_id: 8ad085518262bc17018265525ebb3697 sold_to_id: 8ad085518262bc17018265525ec43699 - id: 8ad08ccf8437067601843a7af4e64rq3 updated_by_id: 2c92c0946a6dffc0016a7faab604299b updated_time: '2022-08-03T13:07:53-07:00' created_by_id: 2c92c0946a6dffc0016a7faab604299b created_time: '2022-08-03T13:07:53-07:00' custom_fields: field__c: custom field value account_number: RC-0002048901234 billing_document_settings: email_documents: true print_documents: false invoice_template_id: 8f64d4d754739d85d0346e00ef77e50d additional_email: - jane.doe@gmail.com - ' james.lawerence@gmail.com' batch: Batch1 bill_cycle_day: 0 name: Amy Lawrence Account payment_terms: Due Upon Receipt auto_pay: false currency: USD enabled: true remaining_debit_memo_balance: 0 remaining_invoice_balance: 0 remaining_credit_memo_balance: 0 remaining_payment_balance: 0 bill_to_id: 8ad085518262bc17018265525ebb3697 sold_to_id: 8ad085518262bc17018265525ec43699 - id: 8ad08ccf8437067601843a7af4e64rq3 updated_by_id: 2c92c0946a6dffc0016a7faab604299b updated_time: '2022-08-03T13:07:53-07:00' created_by_id: 2c92c0946a6dffc0016a7faab604299b created_time: '2022-08-03T13:07:53-07:00' custom_fields: field__c: custom field value account_number: RC-0002048901234 billing_document_settings: email_documents: true print_documents: false invoice_template_id: 8f64d4d754739d85d0346e00ef77e50d additional_email: - jane.doe@gmail.com - ' james.lawerence@gmail.com' batch: Batch1 bill_cycle_day: 0 name: Amy Lawrence Account payment_terms: Due Upon Receipt auto_pay: false currency: USD enabled: true remaining_debit_memo_balance: 0 remaining_invoice_balance: 0 remaining_credit_memo_balance: 0 remaining_payment_balance: 0 bill_to_id: 8ad085518262bc17018265525ebb3697 sold_to_id: 8ad085518262bc17018265525ec43699 - id: 8ad08ccf8437067601843a7af4e64rq3 updated_by_id: 2c92c0946a6dffc0016a7faab604299b updated_time: '2022-08-03T13:07:53-07:00' created_by_id: 2c92c0946a6dffc0016a7faab604299b created_time: '2022-08-03T13:07:53-07:00' custom_fields: field__c: custom field value account_number: RC-0002048901234 billing_document_settings: email_documents: true print_documents: false invoice_template_id: 8f64d4d754739d85d0346e00ef77e50d additional_email: - jane.doe@gmail.com - ' james.lawerence@gmail.com' batch: Batch1 bill_cycle_day: 0 name: Amy Lawrence Account payment_terms: Due Upon Receipt auto_pay: false currency: USD enabled: true remaining_debit_memo_balance: 0 remaining_invoice_balance: 0 remaining_credit_memo_balance: 0 remaining_payment_balance: 0 bill_to_id: 8ad085518262bc17018265525ebb3697 sold_to_id: 8ad085518262bc17018265525ec43699 headers: ratelimit-limit: description: >- The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information. schema: type: string ratelimit-remaining: description: >- The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information. schema: type: number ratelimit-reset: description: >- The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information. schema: type: number zuora-request-id: description: Zuora’s internal identifier for this request. schema: type: string zuora-track-id: description: >- A user-supplied identifier for this request. If you supply a `zuora-track-id` as a request header, Zuora returns the `zuora-track-id` as a response header. schema: type: string '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Bad Request example: type: bad_request errors: - code: invalid_parameter parameter: currency message: '''currency'' length must be between 3 and 3' retryable: false '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Unauthorized example: type: unauthorized errors: [] retryable: false '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Not Found example: type: not_found errors: - code: resource_not_found parameter: id message: >- Resource 2c92c0f974e9737a0175034cc0cc10c could not be found retryable: false '405': description: Method Not Allowed content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Method Not Allowed example: type: method_not_allowed retryable: false errors: [] '429': description: Too Many Requests content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Too Many Requests example: type: too_many_requests errors: [] '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Internal Server Error example: type: internal_server_error errors: [] '502': description: Bad Gateway content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Bad Gateway example: type: bad_gateway errors: [] '503': description: Service Unavailable content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Service Unavailable example: type: service_unavailable errors: [] '504': description: Gateway Timeout content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Gateway Timeout example: type: gateway_timeout errors: [] post: operationId: createAccount summary: Create an account tags: - Accounts description: Creates a new account object. requestBody: content: application/json: schema: $ref: '#/components/schemas/accountCreateRequest' example: name: Amy Lawrence Account currency: USD bill_to: first_name: Amy last_name: Lawrence address: line1: 101 Redwood Shores Parkway line2: Suite 1150 city: Redwood City state: California country: USA postal_code: '94065' work_phone: (888) 976-9056 work_email: amy.lawrence@gmail.com sold_to: first_name: Amy last_name: Lawrence address: line1: 101 Redwood Shores Parkway city: Redwood City state: California country: USA postal_code: '94065' work_phone: (888) 976-9056 work_email: amy.lawrence@gmail.com custom_fields: field__c: custom field value payment_terms: Due Upon Receipt tax_certificate: start_date: '2022-01-01' end_date: '2023-01-01' state: pending sequence_set_id: 8f64d4d793733fb0be444ff770a932c7 billing_document_settings: additional_email: - jane.doe@gmail.com - james.lawerence@gmail.com email_documents: true required: true parameters: - in: query name: fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `auto_pay`, `account_number`, `bill_to_id`, `sold_to_id`, `billing_document_settings`, `communication_profile_id`, `crm_id`, `sales_rep`, `parent_account_id`, `payment_gateway`, `payment_terms`, `remaining_credit_memo_balance`, `remaining_debit_memo_balance`, `remaining_invoice_balance`, `remaining_payment_balance`, `sequence_set_id`, `tax_certificate`, `batch`, `tax_identifier`, `bill_cycle_day`, `description`, `name`, `currency`, `default_payment_method_id`, `enabled`
- in: query name: subscriptions.fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `subscription_number`, `state`, `account_id`, `invoice_owner_account_id`, `auto_renew`, `version`, `initial_term`, `current_term`, `renewal_term`, `start_date`, `end_date`, `description`, `contract_effective`, `service_activation`, `customer_acceptance`, `invoice_separately`, `latest_version`, `payment_terms`, `billing_document_settings`, `bill_to_id`, `sold_to_id`, `contracted_mrr`, `order_number`
- in: query name: subscription_plans.fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `name`, `plan_id`, `subscription_id`, `product_id`
- in: query name: subscription_items.fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `start_date`, `end_date`, `charge_model`, `charge_type`, `tiers`, `subscription_item_number`, `name`, `description`, `charged_through_date`, `recurring`, `price_id`, `start_event`, `tax_code`, `tax_inclusive`, `unit_of_measure`, `quantity`, `price_base_interval`, `overage`, `subscription_plan_id`, `tiers_mode`, `processed_through_date`, `active`, `state`, `unit_amount`, `amount`, `discount_amount`, `discount_percent`
- in: query name: invoice_owner_account.fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `auto_pay`, `account_number`, `bill_to_id`, `sold_to_id`, `billing_document_settings`, `communication_profile_id`, `crm_id`, `sales_rep`, `parent_account_id`, `payment_gateway`, `payment_terms`, `remaining_credit_memo_balance`, `remaining_debit_memo_balance`, `remaining_invoice_balance`, `remaining_payment_balance`, `sequence_set_id`, `tax_certificate`, `batch`, `tax_identifier`, `bill_cycle_day`, `description`, `name`, `currency`, `default_payment_method_id`, `enabled`
- in: query name: plan.fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `start_date`, `end_date`, `name`, `active`, `description`, `plan_number`, `product_id`, `active_currencies`
- in: query name: payment_methods.fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `type`, `account_id`, `bank_identification_number`, `device_session_id`, `ip_address`, `maximum_payment_attempts`, `payment_retry_interval`, `state`, `use_default_retry_rule`, `existing_mandate`, `last_failed_sale_transaction_time`, `last_transaction_time`, `last_transaction_status`, `number_of_consecutive_failures`, `total_number_of_processed_payments`, `total_number_of_error_payments`, `billing_details`, `card`, `apple_pay`, `google_pay`, `ach_debit`, `cc_ref`, `paypal_adaptive`, `paypal_express_native`, `paypal_express`, `sepa_debit`, `betalings_debit`, `autogiro_debit`, `bacs_debit`, `au_becs_debit`, `nz_becs_debit`, `pad_debit`
- in: query name: payments.fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `payment_number`, `payment_date`, `gateway_id`, `payment_method_id`, `payout_id`, `reference_id`, `second_reference_id`, `statement_descriptor_phone`, `state`, `statement_descriptor`, `account_id`, `amount`, `amount_applied`, `amount_refunded`, `remaining_balance`, `currency`, `description`, `authorization_id`, `external`, `gateway_order_id`, `gateway_reconciliation_status`, `gateway_reconciliation_reason`, `gateway_response`, `gateway_response_code`, `gateway_state`, `state_transitions`, `gateway_state_transitions`
- in: query name: billing_documents.fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `account_id`, `balance`, `description`, `state`, `tax`
- in: query name: billing_document_items.fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `price_id`, `discount_item`, `deferred_revenue_account`, `description`, `name`, `quantity`, `recognized_revenue_account`, `service_end`, `service_start`, `accounts_receivable_account`, `subscription_id`, `subscription_item_id`, `tax`, `tax_inclusive`, `unit_amount`
- in: query name: bill_to.fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `account_id`, `address`, `home_phone`, `first_name`, `last_name`, `email`, `work_email`, `nickname`, `other_phone`, `work_phone`, `mobile_phone`, `tax_region`, `other_phone_type`, `fax`
- in: query name: sold_to.fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `account_id`, `address`, `home_phone`, `first_name`, `last_name`, `email`, `work_email`, `nickname`, `other_phone`, `work_phone`, `mobile_phone`, `tax_region`, `other_phone_type`, `fax`
- in: query name: default_payment_method.fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `type`, `account_id`, `bank_identification_number`, `device_session_id`, `ip_address`, `maximum_payment_attempts`, `payment_retry_interval`, `state`, `use_default_retry_rule`, `existing_mandate`, `last_failed_sale_transaction_time`, `last_transaction_time`, `last_transaction_status`, `number_of_consecutive_failures`, `total_number_of_processed_payments`, `total_number_of_error_payments`, `billing_details`, `card`, `apple_pay`, `google_pay`, `ach_debit`, `cc_ref`, `paypal_adaptive`, `paypal_express_native`, `paypal_express`, `sepa_debit`, `betalings_debit`, `autogiro_debit`, `bacs_debit`, `au_becs_debit`, `nz_becs_debit`, `pad_debit`
- in: query name: usage_records.fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `account_id`, `account_number`, `subscription_item_id`, `subscription_item_number`, `subscription_id`, `subscription_number`, `unit_of_measure`, `description`, `end_time`, `state`, `start_time`, `quantity`
- in: query name: invoices.fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `state`, `balance`, `due_date`, `invoice_number`, `posted_by_id`, `state_transitions`, `description`, `account_id`, `total`, `subtotal`, `tax`, `paid`, `past_due`, `document_date`, `amount_paid`, `amount_refunded`, `payment_terms`, `bill_to_id`, `sold_to_id`, `billing_document_settings`
- in: query name: credit_memos.fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `credit_memo_number`, `state_transitions`, `description`, `account_id`, `total`, `subtotal`, `tax`, `document_date`, `exclude_from_auto_apply_rules`, `posted_by_id`, `state`, `balance`, `invoice_id`, `reason_code`, `amount_refunded`, `bill_to_id`, `billing_document_settings`
- in: query name: debit_memos.fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `balance`, `due_date`, `debit_memo_number`, `state_transitions`, `description`, `account_id`, `total`, `subtotal`, `tax`, `document_date`, `posted_by_id`, `state`, `reason_code`, `paid`, `past_due`, `billing_document_settings`, `payment_terms`, `bill_to_id`, `invoice_id`
- in: query name: prepaid_balance.fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `prepaid_UOM`, `start_date`, `end_date`, `total_balance`, `remaining_balance`
- in: query name: transactions.fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `transaction_date`, `type`, `quantity`
- in: query name: expand[] required: false schema: type: array x-java-sdk-legacy-param: true items: type: string description: >- Allows you to expand responses by including related object information in a single call. See the [Expand responses](https://developer.zuora.com/quickstart-api/tutorial/expand-responses/) section of the Quickstart API Tutorials for detailed instructions. - in: query name: filter[] required: false schema: type: array x-java-sdk-legacy-param: false items: type: string description: >- A case-sensitive filter on the list. See the [Filter lists](https://developer.zuora.com/quickstart-api/tutorial/filter-lists/) section of the Quickstart API Tutorial for detailed instructions. Note that the filters on this operation are only applicable to the related objects. For example, when you are calling the "Retrieve a billing document" operation, you can use the `filter[]` parameter on the related objects such as `filter[]=items[account_id].EQ:8ad09e208858b5cf0188595208151c63` - in: query name: page_size required: false schema: type: integer x-java-sdk-legacy-param: false minimum: 1 maximum: 99 description: >- The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 99, Zuora will return a 400 error. - $ref: '#/components/parameters/zuora-track-id' - $ref: '#/components/parameters/async' - $ref: '#/components/parameters/zuora-entity-id' - $ref: '#/components/parameters/idempotency-key' - $ref: '#/components/parameters/accept-encoding' - $ref: '#/components/parameters/content-encoding' x-operation-type: create x-code-samples: - lang: Curl label: cURL source: >- curl --request POST --url https://rest.apisandbox.zuora.com/v2/accounts --header 'Authorization: Bearer 8d17d8e8cc36419998a205896d670ed2' --header 'Content-Type: application/json' --data '{ "name": "Amy Lawrence", "bill_to": { "first_name": "Amy", "last_name": "Lawrence", "address": { "country": "USA", "state": "CA" } }, "currency": "USD" }' - lang: Java label: Java source: >- AccountContactCreateRequest contactCreateRequest = new AccountContactCreateRequest() .firstName("Amy") .lastName("Lawrence") .address(new Address() .country("USA") .state("CA")); AccountCreateRequest accountCreateRequest = new AccountCreateRequest() .name("Amy Lawrence") .billTo(contactCreateRequest) .currency("USD"); Account newAccount = zuoraClient.accounts().createAccount(accountCreateRequest); - lang: JavaScript label: Node source: >- const contactCreateRequest = { first_name: "Amy", last_name: "Lawrence", address: { country: "USA", state: "CA" } }; const accountCreateRequest = { name: "Amy Lawrence's account", bill_to: contactCreateRequest, currency: "USD" }; const newAccount = await zuoraClient.accounts.createAccount(accountCreateRequest); x-group-parameters: true responses: '201': description: Default Response content: application/json: schema: $ref: '#/components/schemas/account' example: id: 8ad08ccf8437067601843a7af4e64rq3 updated_by_id: 2c92c0946a6dffc0016a7faab604299b updated_time: '2022-08-03T13:07:53-07:00' created_by_id: 2c92c0946a6dffc0016a7faab604299b created_time: '2022-08-03T13:07:53-07:00' custom_fields: field__c: custom field value account_number: RC-0002048901234 billing_document_settings: email_documents: true print_documents: false invoice_template_id: 8f64d4d754739d85d0346e00ef77e50d additional_email: - jane.doe@gmail.com - ' james.lawerence@gmail.com' batch: Batch1 bill_cycle_day: 0 name: Amy Lawrence Account payment_terms: Due Upon Receipt auto_pay: false currency: USD enabled: true remaining_debit_memo_balance: 0 remaining_invoice_balance: 0 remaining_credit_memo_balance: 0 remaining_payment_balance: 0 bill_to_id: 8ad085518262bc17018265525ebb3697 sold_to_id: 8ad085518262bc17018265525ec43699 headers: ratelimit-limit: description: >- The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information. schema: type: string ratelimit-remaining: description: >- The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information. schema: type: number ratelimit-reset: description: >- The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information. schema: type: number zuora-request-id: description: Zuora’s internal identifier for this request. schema: type: string zuora-track-id: description: >- A user-supplied identifier for this request. If you supply a `zuora-track-id` as a request header, Zuora returns the `zuora-track-id` as a response header. schema: type: string '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Bad Request example: type: bad_request errors: - code: invalid_parameter parameter: currency message: '''currency'' length must be between 3 and 3' retryable: false '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Unauthorized example: type: unauthorized errors: [] retryable: false '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Not Found example: type: not_found errors: - code: resource_not_found parameter: id message: >- Resource 2c92c0f974e9737a0175034cc0cc10c could not be found retryable: false '405': description: Method Not Allowed content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Method Not Allowed example: type: method_not_allowed retryable: false errors: [] '429': description: Too Many Requests content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Too Many Requests example: type: too_many_requests errors: [] '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Internal Server Error example: type: internal_server_error errors: [] '502': description: Bad Gateway content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Bad Gateway example: type: bad_gateway errors: [] '503': description: Service Unavailable content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Service Unavailable example: type: service_unavailable errors: [] '504': description: Gateway Timeout content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Gateway Timeout example: type: gateway_timeout errors: [] /accounts/{account_id}: get: operationId: getAccount summary: Retrieve an account tags: - Accounts description: Retrieves the account with the given ID. parameters: - in: query name: fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `auto_pay`, `account_number`, `bill_to_id`, `sold_to_id`, `billing_document_settings`, `communication_profile_id`, `crm_id`, `sales_rep`, `parent_account_id`, `payment_gateway`, `payment_terms`, `remaining_credit_memo_balance`, `remaining_debit_memo_balance`, `remaining_invoice_balance`, `remaining_payment_balance`, `sequence_set_id`, `tax_certificate`, `batch`, `tax_identifier`, `bill_cycle_day`, `description`, `name`, `currency`, `default_payment_method_id`, `enabled`
- in: query name: subscriptions.fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `subscription_number`, `state`, `account_id`, `invoice_owner_account_id`, `auto_renew`, `version`, `initial_term`, `current_term`, `renewal_term`, `start_date`, `end_date`, `description`, `contract_effective`, `service_activation`, `customer_acceptance`, `invoice_separately`, `latest_version`, `payment_terms`, `billing_document_settings`, `bill_to_id`, `sold_to_id`, `contracted_mrr`, `order_number`
- in: query name: subscription_plans.fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `name`, `plan_id`, `subscription_id`, `product_id`
- in: query name: subscription_items.fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `start_date`, `end_date`, `charge_model`, `charge_type`, `tiers`, `subscription_item_number`, `name`, `description`, `charged_through_date`, `recurring`, `price_id`, `start_event`, `tax_code`, `tax_inclusive`, `unit_of_measure`, `quantity`, `price_base_interval`, `overage`, `subscription_plan_id`, `tiers_mode`, `processed_through_date`, `active`, `state`, `unit_amount`, `amount`, `discount_amount`, `discount_percent`
- in: query name: invoice_owner_account.fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `auto_pay`, `account_number`, `bill_to_id`, `sold_to_id`, `billing_document_settings`, `communication_profile_id`, `crm_id`, `sales_rep`, `parent_account_id`, `payment_gateway`, `payment_terms`, `remaining_credit_memo_balance`, `remaining_debit_memo_balance`, `remaining_invoice_balance`, `remaining_payment_balance`, `sequence_set_id`, `tax_certificate`, `batch`, `tax_identifier`, `bill_cycle_day`, `description`, `name`, `currency`, `default_payment_method_id`, `enabled`
- in: query name: plan.fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `start_date`, `end_date`, `name`, `active`, `description`, `plan_number`, `product_id`, `active_currencies`
- in: query name: payment_methods.fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `type`, `account_id`, `bank_identification_number`, `device_session_id`, `ip_address`, `maximum_payment_attempts`, `payment_retry_interval`, `state`, `use_default_retry_rule`, `existing_mandate`, `last_failed_sale_transaction_time`, `last_transaction_time`, `last_transaction_status`, `number_of_consecutive_failures`, `total_number_of_processed_payments`, `total_number_of_error_payments`, `billing_details`, `card`, `apple_pay`, `google_pay`, `ach_debit`, `cc_ref`, `paypal_adaptive`, `paypal_express_native`, `paypal_express`, `sepa_debit`, `betalings_debit`, `autogiro_debit`, `bacs_debit`, `au_becs_debit`, `nz_becs_debit`, `pad_debit`
- in: query name: payments.fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `payment_number`, `payment_date`, `gateway_id`, `payment_method_id`, `payout_id`, `reference_id`, `second_reference_id`, `statement_descriptor_phone`, `state`, `statement_descriptor`, `account_id`, `amount`, `amount_applied`, `amount_refunded`, `remaining_balance`, `currency`, `description`, `authorization_id`, `external`, `gateway_order_id`, `gateway_reconciliation_status`, `gateway_reconciliation_reason`, `gateway_response`, `gateway_response_code`, `gateway_state`, `state_transitions`, `gateway_state_transitions`
- in: query name: billing_documents.fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `account_id`, `balance`, `description`, `state`, `tax`
- in: query name: billing_document_items.fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `price_id`, `discount_item`, `deferred_revenue_account`, `description`, `name`, `quantity`, `recognized_revenue_account`, `service_end`, `service_start`, `accounts_receivable_account`, `subscription_id`, `subscription_item_id`, `tax`, `tax_inclusive`, `unit_amount`
- in: query name: bill_to.fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `account_id`, `address`, `home_phone`, `first_name`, `last_name`, `email`, `work_email`, `nickname`, `other_phone`, `work_phone`, `mobile_phone`, `tax_region`, `other_phone_type`, `fax`
- in: query name: sold_to.fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `account_id`, `address`, `home_phone`, `first_name`, `last_name`, `email`, `work_email`, `nickname`, `other_phone`, `work_phone`, `mobile_phone`, `tax_region`, `other_phone_type`, `fax`
- in: query name: default_payment_method.fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `type`, `account_id`, `bank_identification_number`, `device_session_id`, `ip_address`, `maximum_payment_attempts`, `payment_retry_interval`, `state`, `use_default_retry_rule`, `existing_mandate`, `last_failed_sale_transaction_time`, `last_transaction_time`, `last_transaction_status`, `number_of_consecutive_failures`, `total_number_of_processed_payments`, `total_number_of_error_payments`, `billing_details`, `card`, `apple_pay`, `google_pay`, `ach_debit`, `cc_ref`, `paypal_adaptive`, `paypal_express_native`, `paypal_express`, `sepa_debit`, `betalings_debit`, `autogiro_debit`, `bacs_debit`, `au_becs_debit`, `nz_becs_debit`, `pad_debit`
- in: query name: usage_records.fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `account_id`, `account_number`, `subscription_item_id`, `subscription_item_number`, `subscription_id`, `subscription_number`, `unit_of_measure`, `description`, `end_time`, `state`, `start_time`, `quantity`
- in: query name: invoices.fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `state`, `balance`, `due_date`, `invoice_number`, `posted_by_id`, `state_transitions`, `description`, `account_id`, `total`, `subtotal`, `tax`, `paid`, `past_due`, `document_date`, `amount_paid`, `amount_refunded`, `payment_terms`, `bill_to_id`, `sold_to_id`, `billing_document_settings`
- in: query name: credit_memos.fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `credit_memo_number`, `state_transitions`, `description`, `account_id`, `total`, `subtotal`, `tax`, `document_date`, `exclude_from_auto_apply_rules`, `posted_by_id`, `state`, `balance`, `invoice_id`, `reason_code`, `amount_refunded`, `bill_to_id`, `billing_document_settings`
- in: query name: debit_memos.fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `balance`, `due_date`, `debit_memo_number`, `state_transitions`, `description`, `account_id`, `total`, `subtotal`, `tax`, `document_date`, `posted_by_id`, `state`, `reason_code`, `paid`, `past_due`, `billing_document_settings`, `payment_terms`, `bill_to_id`, `invoice_id`
- in: query name: prepaid_balance.fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `prepaid_UOM`, `start_date`, `end_date`, `total_balance`, `remaining_balance`
- in: query name: transactions.fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `transaction_date`, `type`, `quantity`
- in: query name: expand[] required: false schema: type: array x-java-sdk-legacy-param: true items: type: string description: >- Allows you to expand responses by including related object information in a single call. See the [Expand responses](https://developer.zuora.com/quickstart-api/tutorial/expand-responses/) section of the Quickstart API Tutorials for detailed instructions. - in: query name: filter[] required: false schema: type: array x-java-sdk-legacy-param: false items: type: string description: >- A case-sensitive filter on the list. See the [Filter lists](https://developer.zuora.com/quickstart-api/tutorial/filter-lists/) section of the Quickstart API Tutorial for detailed instructions. Note that the filters on this operation are only applicable to the related objects. For example, when you are calling the "Retrieve a billing document" operation, you can use the `filter[]` parameter on the related objects such as `filter[]=items[account_id].EQ:8ad09e208858b5cf0188595208151c63` - in: query name: page_size required: false schema: type: integer x-java-sdk-legacy-param: false minimum: 1 maximum: 99 description: >- The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 99, Zuora will return a 400 error. - in: path name: account_id required: true schema: type: string description: Identifier for the account, either `account_number` or `account_id` - $ref: '#/components/parameters/zuora-track-id' - $ref: '#/components/parameters/zuora-entity-id' - $ref: '#/components/parameters/idempotency-key' - $ref: '#/components/parameters/accept-encoding' - $ref: '#/components/parameters/content-encoding' x-operation-type: get x-code-samples: - lang: Curl label: cURL source: > curl --request GET --url https://rest.apisandbox.zuora.com/v2/accounts/2c92c0f86a8dd422016a9e7a70116b0d --header 'Authorization: Bearer dcf5d050c6e7493688859d04da581938' --header 'Content-Type: application/json' - lang: Java label: Java source: >- Account accountResponse = zuoraClient.accounts().getAccount(newAccount.getId(),null); System.out.println(accountResponse); - lang: JavaScript label: Node source: >- const accountResponse = await zuoraClient.accounts.getAccount('RC-00020836'); console.log(accountResponse); x-group-parameters: true responses: '200': description: Default Response content: application/json: schema: $ref: '#/components/schemas/account' example: id: 8ad08ccf8437067601843a7af4e64rq3 updated_by_id: 2c92c0946a6dffc0016a7faab604299b updated_time: '2022-08-03T13:07:53-07:00' created_by_id: 2c92c0946a6dffc0016a7faab604299b created_time: '2022-08-03T13:07:53-07:00' custom_fields: field__c: custom field value account_number: RC-0002048901234 billing_document_settings: email_documents: true print_documents: false invoice_template_id: 8f64d4d754739d85d0346e00ef77e50d additional_email: - jane.doe@gmail.com - ' james.lawerence@gmail.com' batch: Batch1 bill_cycle_day: 0 name: Amy Lawrence Account payment_terms: Due Upon Receipt auto_pay: false currency: USD enabled: true remaining_debit_memo_balance: 0 remaining_invoice_balance: 0 remaining_credit_memo_balance: 0 remaining_payment_balance: 0 bill_to_id: 8ad085518262bc17018265525ebb3697 sold_to_id: 8ad085518262bc17018265525ec43699 headers: ratelimit-limit: description: >- The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information. schema: type: string ratelimit-remaining: description: >- The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information. schema: type: number ratelimit-reset: description: >- The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information. schema: type: number zuora-request-id: description: Zuora’s internal identifier for this request. schema: type: string zuora-track-id: description: >- A user-supplied identifier for this request. If you supply a `zuora-track-id` as a request header, Zuora returns the `zuora-track-id` as a response header. schema: type: string '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Bad Request example: type: bad_request errors: - code: invalid_parameter parameter: currency message: '''currency'' length must be between 3 and 3' retryable: false '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Unauthorized example: type: unauthorized errors: [] retryable: false '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Not Found example: type: not_found errors: - code: resource_not_found parameter: id message: >- Resource 2c92c0f974e9737a0175034cc0cc10c could not be found retryable: false '405': description: Method Not Allowed content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Method Not Allowed example: type: method_not_allowed retryable: false errors: [] '429': description: Too Many Requests content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Too Many Requests example: type: too_many_requests errors: [] '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Internal Server Error example: type: internal_server_error errors: [] '502': description: Bad Gateway content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Bad Gateway example: type: bad_gateway errors: [] '503': description: Service Unavailable content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Service Unavailable example: type: service_unavailable errors: [] '504': description: Gateway Timeout content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Gateway Timeout example: type: gateway_timeout errors: [] patch: operationId: updateAccount summary: Update an account tags: - Accounts description: >- Updates the specified account by setting the values of the parameters passed. Any parameters not provided will be left unchanged. requestBody: content: application/json: schema: $ref: '#/components/schemas/accountPatchRequest' example: name: Johnny Smith custom_fields: field__c: custom field value required: true parameters: - in: query name: fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `auto_pay`, `account_number`, `bill_to_id`, `sold_to_id`, `billing_document_settings`, `communication_profile_id`, `crm_id`, `sales_rep`, `parent_account_id`, `payment_gateway`, `payment_terms`, `remaining_credit_memo_balance`, `remaining_debit_memo_balance`, `remaining_invoice_balance`, `remaining_payment_balance`, `sequence_set_id`, `tax_certificate`, `batch`, `tax_identifier`, `bill_cycle_day`, `description`, `name`, `currency`, `default_payment_method_id`, `enabled`
- in: query name: subscriptions.fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `subscription_number`, `state`, `account_id`, `invoice_owner_account_id`, `auto_renew`, `version`, `initial_term`, `current_term`, `renewal_term`, `start_date`, `end_date`, `description`, `contract_effective`, `service_activation`, `customer_acceptance`, `invoice_separately`, `latest_version`, `payment_terms`, `billing_document_settings`, `bill_to_id`, `sold_to_id`, `contracted_mrr`, `order_number`
- in: query name: subscription_plans.fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `name`, `plan_id`, `subscription_id`, `product_id`
- in: query name: subscription_items.fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `start_date`, `end_date`, `charge_model`, `charge_type`, `tiers`, `subscription_item_number`, `name`, `description`, `charged_through_date`, `recurring`, `price_id`, `start_event`, `tax_code`, `tax_inclusive`, `unit_of_measure`, `quantity`, `price_base_interval`, `overage`, `subscription_plan_id`, `tiers_mode`, `processed_through_date`, `active`, `state`, `unit_amount`, `amount`, `discount_amount`, `discount_percent`
- in: query name: invoice_owner_account.fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `auto_pay`, `account_number`, `bill_to_id`, `sold_to_id`, `billing_document_settings`, `communication_profile_id`, `crm_id`, `sales_rep`, `parent_account_id`, `payment_gateway`, `payment_terms`, `remaining_credit_memo_balance`, `remaining_debit_memo_balance`, `remaining_invoice_balance`, `remaining_payment_balance`, `sequence_set_id`, `tax_certificate`, `batch`, `tax_identifier`, `bill_cycle_day`, `description`, `name`, `currency`, `default_payment_method_id`, `enabled`
- in: query name: plan.fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `start_date`, `end_date`, `name`, `active`, `description`, `plan_number`, `product_id`, `active_currencies`
- in: query name: payment_methods.fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `type`, `account_id`, `bank_identification_number`, `device_session_id`, `ip_address`, `maximum_payment_attempts`, `payment_retry_interval`, `state`, `use_default_retry_rule`, `existing_mandate`, `last_failed_sale_transaction_time`, `last_transaction_time`, `last_transaction_status`, `number_of_consecutive_failures`, `total_number_of_processed_payments`, `total_number_of_error_payments`, `billing_details`, `card`, `apple_pay`, `google_pay`, `ach_debit`, `cc_ref`, `paypal_adaptive`, `paypal_express_native`, `paypal_express`, `sepa_debit`, `betalings_debit`, `autogiro_debit`, `bacs_debit`, `au_becs_debit`, `nz_becs_debit`, `pad_debit`
- in: query name: payments.fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `payment_number`, `payment_date`, `gateway_id`, `payment_method_id`, `payout_id`, `reference_id`, `second_reference_id`, `statement_descriptor_phone`, `state`, `statement_descriptor`, `account_id`, `amount`, `amount_applied`, `amount_refunded`, `remaining_balance`, `currency`, `description`, `authorization_id`, `external`, `gateway_order_id`, `gateway_reconciliation_status`, `gateway_reconciliation_reason`, `gateway_response`, `gateway_response_code`, `gateway_state`, `state_transitions`, `gateway_state_transitions`
- in: query name: billing_documents.fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `account_id`, `balance`, `description`, `state`, `tax`
- in: query name: billing_document_items.fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `price_id`, `discount_item`, `deferred_revenue_account`, `description`, `name`, `quantity`, `recognized_revenue_account`, `service_end`, `service_start`, `accounts_receivable_account`, `subscription_id`, `subscription_item_id`, `tax`, `tax_inclusive`, `unit_amount`
- in: query name: bill_to.fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `account_id`, `address`, `home_phone`, `first_name`, `last_name`, `email`, `work_email`, `nickname`, `other_phone`, `work_phone`, `mobile_phone`, `tax_region`, `other_phone_type`, `fax`
- in: query name: sold_to.fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `account_id`, `address`, `home_phone`, `first_name`, `last_name`, `email`, `work_email`, `nickname`, `other_phone`, `work_phone`, `mobile_phone`, `tax_region`, `other_phone_type`, `fax`
- in: query name: default_payment_method.fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `type`, `account_id`, `bank_identification_number`, `device_session_id`, `ip_address`, `maximum_payment_attempts`, `payment_retry_interval`, `state`, `use_default_retry_rule`, `existing_mandate`, `last_failed_sale_transaction_time`, `last_transaction_time`, `last_transaction_status`, `number_of_consecutive_failures`, `total_number_of_processed_payments`, `total_number_of_error_payments`, `billing_details`, `card`, `apple_pay`, `google_pay`, `ach_debit`, `cc_ref`, `paypal_adaptive`, `paypal_express_native`, `paypal_express`, `sepa_debit`, `betalings_debit`, `autogiro_debit`, `bacs_debit`, `au_becs_debit`, `nz_becs_debit`, `pad_debit`
- in: query name: usage_records.fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `account_id`, `account_number`, `subscription_item_id`, `subscription_item_number`, `subscription_id`, `subscription_number`, `unit_of_measure`, `description`, `end_time`, `state`, `start_time`, `quantity`
- in: query name: invoices.fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `state`, `balance`, `due_date`, `invoice_number`, `posted_by_id`, `state_transitions`, `description`, `account_id`, `total`, `subtotal`, `tax`, `paid`, `past_due`, `document_date`, `amount_paid`, `amount_refunded`, `payment_terms`, `bill_to_id`, `sold_to_id`, `billing_document_settings`
- in: query name: credit_memos.fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `credit_memo_number`, `state_transitions`, `description`, `account_id`, `total`, `subtotal`, `tax`, `document_date`, `exclude_from_auto_apply_rules`, `posted_by_id`, `state`, `balance`, `invoice_id`, `reason_code`, `amount_refunded`, `bill_to_id`, `billing_document_settings`
- in: query name: debit_memos.fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `balance`, `due_date`, `debit_memo_number`, `state_transitions`, `description`, `account_id`, `total`, `subtotal`, `tax`, `document_date`, `posted_by_id`, `state`, `reason_code`, `paid`, `past_due`, `billing_document_settings`, `payment_terms`, `bill_to_id`, `invoice_id`
- in: query name: prepaid_balance.fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `prepaid_UOM`, `start_date`, `end_date`, `total_balance`, `remaining_balance`
- in: query name: transactions.fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `transaction_date`, `type`, `quantity`
- in: query name: expand[] required: false schema: type: array x-java-sdk-legacy-param: true items: type: string description: >- Allows you to expand responses by including related object information in a single call. See the [Expand responses](https://developer.zuora.com/quickstart-api/tutorial/expand-responses/) section of the Quickstart API Tutorials for detailed instructions. - in: query name: filter[] required: false schema: type: array x-java-sdk-legacy-param: false items: type: string description: >- A case-sensitive filter on the list. See the [Filter lists](https://developer.zuora.com/quickstart-api/tutorial/filter-lists/) section of the Quickstart API Tutorial for detailed instructions. Note that the filters on this operation are only applicable to the related objects. For example, when you are calling the "Retrieve a billing document" operation, you can use the `filter[]` parameter on the related objects such as `filter[]=items[account_id].EQ:8ad09e208858b5cf0188595208151c63` - in: query name: page_size required: false schema: type: integer x-java-sdk-legacy-param: false minimum: 1 maximum: 99 description: >- The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 99, Zuora will return a 400 error. - in: path name: account_id required: true schema: type: string description: Identifier for the account, either `account_number` or `account_id` - $ref: '#/components/parameters/zuora-track-id' - $ref: '#/components/parameters/async' - $ref: '#/components/parameters/zuora-entity-id' - $ref: '#/components/parameters/idempotency-key' - $ref: '#/components/parameters/accept-encoding' - $ref: '#/components/parameters/content-encoding' x-operation-type: update x-code-samples: - lang: Curl label: cURL source: >- curl --request PATCH --url https://rest.apisandbox.zuora.com/v2/accounts/2c92c0f86a8dd422016a9e7a70116b0d --header 'Authorization: Bearer 06a297740b184fc384bc57cbe8a04e53' --header 'Content-Type: application/json' --data '{ "name": "Bella's Account", "crm_id": "A12345" }' - lang: Java label: Java source: >- Account oldAccount = zuoraClient.accounts().getAccount("8ad0950c82aa847f0182ae9563f46b84", null); AccountPatchRequest accountPatchRequest = new AccountPatchRequest() .name("Updated Account") .crmId("A12345"); Account updatedAccount = zuoraClient.accounts().updateAccount(oldAccount.getId(),accountPatchRequest); - lang: JavaScript label: Node source: >- const accountPatchRequest = { name: 'Updated Account Name', bill_to: { first_name: "Bella", last_name: "Lawrence", address: { country: "USA", state: "NY" } } }; const updatedAccount = await zuoraClient.accounts.updateAccount('8ad0950c83927b4301839e70a6611e0c', accountPatchRequest); x-group-parameters: true responses: '200': description: Default Response content: application/json: schema: $ref: '#/components/schemas/account' example: id: 8ad085518262bc17018265525eab3696 updated_by_id: 2c92c0946a6dffc0016a7faab604299b updated_time: '2022-08-03T13:12:53-07:00' created_by_id: 2c92c0946a6dffc0016a7faab604299b created_time: '2022-08-03T13:07:53-07:00' custom_fields: field__c: custom field value account_number: RC-00020489 billing_document_settings: email_documents: true print_documents: false invoice_template_id: 8f64d4d754739d85d0346e00ef77e50d additional_email: - jane.doe@gmail.com - ' james.lawerence@gmail.com' batch: Batch1 bill_cycle_day: 0 name: Johnny Smith payment_terms: Due Upon Receipt auto_pay: false currency: USD enabled: true remaining_debit_memo_balance: 0 remaining_invoice_balance: 0 remaining_credit_memo_balance: 0 remaining_payment_balance: 0 bill_to_id: 8ad085518262bc17018265525ebb3697 sold_to_id: 8ad085518262bc17018265525ec43699 headers: ratelimit-limit: description: >- The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information. schema: type: string ratelimit-remaining: description: >- The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information. schema: type: number ratelimit-reset: description: >- The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information. schema: type: number zuora-request-id: description: Zuora’s internal identifier for this request. schema: type: string zuora-track-id: description: >- A user-supplied identifier for this request. If you supply a `zuora-track-id` as a request header, Zuora returns the `zuora-track-id` as a response header. schema: type: string '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Bad Request example: type: bad_request errors: - code: invalid_parameter parameter: currency message: '''currency'' length must be between 3 and 3' retryable: false '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Unauthorized example: type: unauthorized errors: [] retryable: false '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Not Found example: type: not_found errors: - code: resource_not_found parameter: id message: >- Resource 2c92c0f974e9737a0175034cc0cc10c could not be found retryable: false '405': description: Method Not Allowed content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Method Not Allowed example: type: method_not_allowed retryable: false errors: [] '429': description: Too Many Requests content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Too Many Requests example: type: too_many_requests errors: [] '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Internal Server Error example: type: internal_server_error errors: [] '502': description: Bad Gateway content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Bad Gateway example: type: bad_gateway errors: [] '503': description: Service Unavailable content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Service Unavailable example: type: service_unavailable errors: [] '504': description: Gateway Timeout content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Gateway Timeout example: type: gateway_timeout errors: [] delete: operationId: deleteAccount summary: Delete an account tags: - Accounts description: Permanently deletes an account. It cannot be undone. parameters: - in: path name: account_id required: true schema: type: string description: Identifier for the account, either `account_number` or `account_id` - $ref: '#/components/parameters/zuora-track-id' - $ref: '#/components/parameters/async' - $ref: '#/components/parameters/zuora-entity-id' - $ref: '#/components/parameters/idempotency-key' - $ref: '#/components/parameters/accept-encoding' - $ref: '#/components/parameters/content-encoding' x-operation-type: delete x-code-samples: - lang: Curl label: cURL source: > curl --request DELETE --url 'https://rest.apisandbox.zuora.com/v2/accounts/2c92c0f86a8dd422016a9e7a70116b0d' --header 'Authorization: Bearer dcf5d050c6e7493688859d04da581938' --header 'Content-Type: application/json' - lang: Java label: Java source: >- SuccessResponse result = zuoraClient.accounts().deleteAccount(newAccount.getId()); System.out.println(result); - lang: JavaScript label: Node source: >- const deleteAccountResponse = await zuoraClient.accounts.deleteAccount('8ad087e284427311018447079d9e4efe'); console.log(deleteAccountResponse); x-group-parameters: true responses: '204': description: Default Response headers: ratelimit-limit: description: >- The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information. schema: type: string ratelimit-remaining: description: >- The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information. schema: type: number ratelimit-reset: description: >- The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information. schema: type: number zuora-request-id: description: Zuora’s internal identifier for this request. schema: type: string zuora-track-id: description: >- A user-supplied identifier for this request. If you supply a `zuora-track-id` as a request header, Zuora returns the `zuora-track-id` as a response header. schema: type: string '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Bad Request example: type: bad_request errors: - code: invalid_parameter parameter: currency message: '''currency'' length must be between 3 and 3' retryable: false '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Unauthorized example: type: unauthorized errors: [] retryable: false '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Not Found example: type: not_found errors: - code: resource_not_found parameter: id message: >- Resource 2c92c0f974e9737a0175034cc0cc10c could not be found retryable: false '405': description: Method Not Allowed content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Method Not Allowed example: type: method_not_allowed retryable: false errors: [] '429': description: Too Many Requests content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Too Many Requests example: type: too_many_requests errors: [] '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Internal Server Error example: type: internal_server_error errors: [] '502': description: Bad Gateway content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Bad Gateway example: type: bad_gateway errors: [] '503': description: Service Unavailable content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Service Unavailable example: type: service_unavailable errors: [] '504': description: Gateway Timeout content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Gateway Timeout example: type: gateway_timeout errors: [] /accounts/{account_id}/bill: post: operationId: generateBillingDocuments summary: Generate billing documents for an account tags: - Accounts description: Creates billing documents for an account. requestBody: content: application/json: schema: $ref: '#/components/schemas/generateBillingDocumentsAccountRequest' example: target_date: '2023-12-01' subscription_ids: - 8ad0940886748c1501867a78a9444790 - 8ad08cbd86747d0801867a7a7f8445a4 document_date: '2023-02-21' required: true parameters: - in: path name: account_id required: true schema: type: string description: Identifier for the account, either `account_number` or `account_id` - $ref: '#/components/parameters/zuora-track-id' - $ref: '#/components/parameters/async' - $ref: '#/components/parameters/zuora-entity-id' - $ref: '#/components/parameters/idempotency-key' - $ref: '#/components/parameters/accept-encoding' - $ref: '#/components/parameters/content-encoding' x-code-samples: - lang: Curl label: cURL source: >- curl --request POST --url https://rest.apisandbox.zuora.com/v2/accounts/RC-00021202/bill --header 'Authorization: Bearer bf4e7bec20f443cc82388e37193ee428' --header 'Content-Type: application/json' --data '{ "target_date": "2023-06-01", "subscription_ids": [ "8ad08cbd878f3de0018790e028c23dc5" ], "document_date": "2023-02-21" }' x-group-parameters: true responses: '200': description: Default Response content: application/json: schema: $ref: '#/components/schemas/generateBillingDocumentsAccountResponse' example: invoices: next_page: null data: - id: 8ad0934e86748c2001867a7f3c321612 invoice_number: INV00009222 created_by_id: 2c92c0946a6dffc0016a7faab604299b updated_by_id: 2c92c0946a6dffc0016a7faab604299b created_time: '2023-02-22T11:00:04-08:00' updated_time: '2023-02-22T11:00:06-08:00' state_transitions: {} state: draft account_id: 8ad09b2186748c1701867a77cdab118e items: next_page: null data: - amount: 0 created_by_id: 2c92c0946a6dffc0016a7faab604299b discount_item: false created_time: '2023-02-22T11:00:06-08:00' custom_fields: SFDCSynced__c: 'False' description: >- Per minute usage price with tiered and overage pricing id: 8ad0934e86748c2001867a7f43da18af invoice_id: 8ad0934e86748c2001867a7f3c321612 sku: SKU-00011670 name: Usage Price quantity: 0 remaining_balance: 0 service_end: '2023-11-30' service_start: '2023-11-01' subscription_id: 8ad0940886748c1501867a78a9444790 subscription_item_id: 8ad0940886748c1501867a78ada84871 tax: 0 tax_inclusive: false unit_amount: 0 unit_of_measure: Each updated_time: '2023-02-22T11:00:06-08:00' updated_by_id: 2c92c0946a6dffc0016a7faab604299b - amount: 0 created_by_id: 2c92c0946a6dffc0016a7faab604299b discount_item: false created_time: '2023-02-22T11:00:06-08:00' custom_fields: SFDCSynced__c: 'False' description: >- Per minute usage price with tiered and overage pricing id: 8ad0934e86748c2001867a7f43d718ae invoice_id: 8ad0934e86748c2001867a7f3c321612 sku: SKU-00011670 name: Usage Price quantity: 0 remaining_balance: 0 service_end: '2023-10-31' service_start: '2023-10-01' subscription_id: 8ad0940886748c1501867a78a9444790 subscription_item_id: 8ad0940886748c1501867a78ada84871 tax: 0 tax_inclusive: false unit_amount: 0 unit_of_measure: Each updated_time: '2023-02-22T11:00:06-08:00' updated_by_id: 2c92c0946a6dffc0016a7faab604299b total: 611600 subtotal: 611600 tax: 0 balance: 611600 paid: false past_due: true document_date: '2023-02-21' due_date: '2023-02-21' custom_fields: InvoiceWFProcessed__c: '0' EmailSentWorkflow__c: Unprocessed LateFeeApplied__c: 'False' - id: 8ad0934e86748c2001867a7f3b58160f invoice_number: INV00009221 created_by_id: 2c92c0946a6dffc0016a7faab604299b updated_by_id: 2c92c0946a6dffc0016a7faab604299b created_time: '2023-02-22T11:00:04-08:00' updated_time: '2023-02-22T11:00:06-08:00' state_transitions: {} state: draft account_id: 8ad09b2186748c1701867a77cdab118e items: next_page: null data: - amount: 10 created_by_id: 2c92c0946a6dffc0016a7faab604299b discount_item: false created_time: '2023-02-22T11:00:04-08:00' custom_fields: SFDCSynced__c: 'False' description: Monthly fee of the Basic Monthly plan id: 8ad0934e86748c2001867a7f3cb71626 invoice_id: 8ad0934e86748c2001867a7f3b58160f sku: SKU-00011814 name: Basic Monthly Fee quantity: 1 remaining_balance: 10 service_end: '2023-12-21' service_start: '2023-11-22' subscription_id: 8ad08cbd86747d0801867a7a7f8445a4 subscription_item_id: 8ad08cbd86747d0801867a7a7fad45ad tax: 0 tax_inclusive: false unit_amount: 10 updated_time: '2023-02-22T11:00:04-08:00' updated_by_id: 2c92c0946a6dffc0016a7faab604299b - amount: 10 created_by_id: 2c92c0946a6dffc0016a7faab604299b discount_item: false created_time: '2023-02-22T11:00:04-08:00' custom_fields: SFDCSynced__c: 'False' description: Monthly fee of the Basic Monthly plan id: 8ad0934e86748c2001867a7f3cb51625 invoice_id: 8ad0934e86748c2001867a7f3b58160f sku: SKU-00011814 name: Basic Monthly Fee quantity: 1 remaining_balance: 10 service_end: '2023-11-21' service_start: '2023-10-22' subscription_id: 8ad08cbd86747d0801867a7a7f8445a4 subscription_item_id: 8ad08cbd86747d0801867a7a7fad45ad tax: 0 tax_inclusive: false unit_amount: 10 updated_time: '2023-02-22T11:00:04-08:00' updated_by_id: 2c92c0946a6dffc0016a7faab604299b total: 200 subtotal: 200 tax: 0 balance: 200 paid: false past_due: true document_date: '2023-02-21' due_date: '2023-02-21' custom_fields: InvoiceWFProcessed__c: '0' EmailSentWorkflow__c: Unprocessed LateFeeApplied__c: 'False' headers: ratelimit-limit: description: >- The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information. schema: type: string ratelimit-remaining: description: >- The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information. schema: type: number ratelimit-reset: description: >- The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information. schema: type: number zuora-request-id: description: Zuora’s internal identifier for this request. schema: type: string zuora-track-id: description: >- A user-supplied identifier for this request. If you supply a `zuora-track-id` as a request header, Zuora returns the `zuora-track-id` as a response header. schema: type: string '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Bad Request example: type: bad_request errors: - code: invalid_parameter parameter: currency message: '''currency'' length must be between 3 and 3' retryable: false '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Unauthorized example: type: unauthorized errors: [] retryable: false '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Not Found example: type: not_found errors: - code: resource_not_found parameter: id message: >- Resource 2c92c0f974e9737a0175034cc0cc10c could not be found retryable: false '405': description: Method Not Allowed content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Method Not Allowed example: type: method_not_allowed retryable: false errors: [] '429': description: Too Many Requests content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Too Many Requests example: type: too_many_requests errors: [] '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Internal Server Error example: type: internal_server_error errors: [] '502': description: Bad Gateway content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Bad Gateway example: type: bad_gateway errors: [] '503': description: Service Unavailable content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Service Unavailable example: type: service_unavailable errors: [] '504': description: Gateway Timeout content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Gateway Timeout example: type: gateway_timeout errors: [] /accounts/{account_id}/preview: post: operationId: previewAccount summary: Preview an account tags: - Accounts description: >- Generates a preview of future invoice and credit memo items for a customer account. Previewing a customer account shows you how much a single customer will be invoiced from the most recent invoice to a specific end of term date in the future.
Previewing a customer account only calculates taxes for charges if you use Zuora Tax and the price associated with the invoice item is tax inclusive; otherwise, it does not calculate taxes. requestBody: content: application/json: schema: $ref: '#/components/schemas/accountPreviewRequest' required: true parameters: - in: path name: account_id required: true schema: type: string description: Identifier for the account, either `account_number` or `account_id` - $ref: '#/components/parameters/zuora-track-id' - $ref: '#/components/parameters/async' - $ref: '#/components/parameters/zuora-entity-id' - $ref: '#/components/parameters/idempotency-key' - $ref: '#/components/parameters/accept-encoding' - $ref: '#/components/parameters/content-encoding' x-code-samples: - lang: Curl label: cURL source: >- curl --request POST --url 'https://rest.apisandbox.zuora.com/v2/accounts/8ad08dc9877a58d201877b3b39393c44/preview' --header 'Authorization: Bearer 9cddcab8242046c1b7c92e46f8451480' --header 'Content-Type: application/json' --data '{ "target_date": "2023-12-01" }' - lang: Java label: Java source: >2- AccountPreviewRequest accountPreviewRequest = new AccountPreviewRequest() .target_date("2023-12-01"); Account newAccount = zuoraClient.accounts().previewAccount("8ad08dc9877a58d201877b3b39393c44", accountPreviewRequest); - lang: JavaScript label: Node source: >2- const accountPreviewRequest = { target_date: '2023-12-01' }; const newAccount = await zuoraClient.accounts.previewAccount('8ad08dc9877a58d201877b3b39393c44',accountPreviewRequest); x-group-parameters: true responses: '200': description: Default Response content: application/json: schema: $ref: '#/components/schemas/accountPreviewResponse' headers: ratelimit-limit: description: >- The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information. schema: type: string ratelimit-remaining: description: >- The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information. schema: type: number ratelimit-reset: description: >- The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information. schema: type: number zuora-request-id: description: Zuora’s internal identifier for this request. schema: type: string zuora-track-id: description: >- A user-supplied identifier for this request. If you supply a `zuora-track-id` as a request header, Zuora returns the `zuora-track-id` as a response header. schema: type: string '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Bad Request example: type: bad_request errors: - code: invalid_parameter parameter: currency message: '''currency'' length must be between 3 and 3' retryable: false '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Unauthorized example: type: unauthorized errors: [] retryable: false '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Not Found example: type: not_found errors: - code: resource_not_found parameter: id message: >- Resource 2c92c0f974e9737a0175034cc0cc10c could not be found retryable: false '405': description: Method Not Allowed content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Method Not Allowed example: type: method_not_allowed retryable: false errors: [] '429': description: Too Many Requests content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Too Many Requests example: type: too_many_requests errors: [] '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Internal Server Error example: type: internal_server_error errors: [] '502': description: Bad Gateway content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Bad Gateway example: type: bad_gateway errors: [] '503': description: Service Unavailable content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Service Unavailable example: type: service_unavailable errors: [] '504': description: Gateway Timeout content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Gateway Timeout example: type: gateway_timeout errors: [] /billing_documents/{billing_document_id}: get: operationId: getBillingDocument summary: Retrieve a billing document tags: - Billing Documents description: Retrieves the billing document with the given ID. parameters: - in: query name: fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `account_id`, `balance`, `description`, `state`, `tax`
- in: query name: billing_document_items.fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `price_id`, `discount_item`, `deferred_revenue_account`, `description`, `name`, `quantity`, `recognized_revenue_account`, `service_end`, `service_start`, `accounts_receivable_account`, `subscription_id`, `subscription_item_id`, `tax`, `tax_inclusive`, `unit_amount`
- in: query name: taxation_items.fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `amount`, `amount_exempt`, `tax_date`, `jurisdiction`, `location_code`, `name`, `sales_tax_payable_account`, `tax_code`, `tax_code_name`, `tax_rate`, `tax_rate_name`, `tax_inclusive`, `tax_rate_type`
- in: query name: expand[] required: false schema: type: array x-java-sdk-legacy-param: true items: type: string description: >- Allows you to expand responses by including related object information in a single call. See the [Expand responses](https://developer.zuora.com/quickstart-api/tutorial/expand-responses/) section of the Quickstart API Tutorials for detailed instructions. - in: query name: filter[] required: false schema: type: array x-java-sdk-legacy-param: false items: type: string description: >- A case-sensitive filter on the list. See the [Filter lists](https://developer.zuora.com/quickstart-api/tutorial/filter-lists/) section of the Quickstart API Tutorial for detailed instructions. Note that the filters on this operation are only applicable to the related objects. For example, when you are calling the "Retrieve a billing document" operation, you can use the `filter[]` parameter on the related objects such as `filter[]=items[account_id].EQ:8ad09e208858b5cf0188595208151c63` - in: query name: page_size required: false schema: type: integer x-java-sdk-legacy-param: false minimum: 1 maximum: 99 description: >- The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 99, Zuora will return a 400 error. - in: path name: billing_document_id required: true schema: type: string description: >- Identifier for the billingDocument, either `billing_document_number` or `billing_document_id` - $ref: '#/components/parameters/zuora-track-id' - $ref: '#/components/parameters/zuora-entity-id' - $ref: '#/components/parameters/idempotency-key' - $ref: '#/components/parameters/accept-encoding' - $ref: '#/components/parameters/content-encoding' x-operation-type: get x-code-samples: - lang: Curl label: cURL source: > curl -X GET "https://rest.sandbox.na.zuora.com/v2/billing_documents/8ad0855180f9da510180fbf80db40c79" -H "Authorization: Bearer 6d151216ef504f65b8ff6e9e9e8356d3" -H "Content-Type: application/json" - lang: Java label: Java source: >- BillingDocument billingDocumentResponse = zuoraClient.billingDocuments().getBillingDocument(newInvoice.getId(),null,null); System.out.println(billingDocumentResponse); - lang: JavaScript label: Node source: >- const billingDocResponse = await zuoraClient.billingDocuments.getBillingDocument('8ad0887183f1cbe60183f5ccc9631fe8',{ expand:['items'] }); console.log(billingDocResponse); x-group-parameters: true responses: '200': description: Default Response content: application/json: schema: $ref: '#/components/schemas/billingDocument' example: id: 8ad093f27f54fa8d017f6b191ff02543 updated_by_id: 2c92c0946a6dffc0016a7faab604299b updated_time: '2022-09-07T14:16:31-07:00' created_by_id: 2c92c0946a6dffc0016a7faab604299b created_time: '2022-03-08T11:54:43-08:00' custom_fields: field__c: custom field value account_id: 2c92c0f96abc17de016abd62bd0c5854 description: comments due_date: '2020-02-01' document_date: '2020-02-01' type: invoice billing_document_number: INV00006606 amount_refunded: 0 state_transitions: posted_at: '2022-03-08T11:54:43-08:00' posted_by_id: 2c92c0946a6dffc0016a7faab604299b state: open total: 300 subtotal: 300 tax: 0 remaining_balance: 225 amount_paid: 75 paid: false past_due: true headers: ratelimit-limit: description: >- The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information. schema: type: string ratelimit-remaining: description: >- The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information. schema: type: number ratelimit-reset: description: >- The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information. schema: type: number zuora-request-id: description: Zuora’s internal identifier for this request. schema: type: string zuora-track-id: description: >- A user-supplied identifier for this request. If you supply a `zuora-track-id` as a request header, Zuora returns the `zuora-track-id` as a response header. schema: type: string '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Bad Request example: type: bad_request errors: - code: invalid_parameter parameter: currency message: '''currency'' length must be between 3 and 3' retryable: false '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Unauthorized example: type: unauthorized errors: [] retryable: false '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Not Found example: type: not_found errors: - code: resource_not_found parameter: id message: >- Resource 2c92c0f974e9737a0175034cc0cc10c could not be found retryable: false '405': description: Method Not Allowed content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Method Not Allowed example: type: method_not_allowed retryable: false errors: [] '429': description: Too Many Requests content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Too Many Requests example: type: too_many_requests errors: [] '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Internal Server Error example: type: internal_server_error errors: [] '502': description: Bad Gateway content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Bad Gateway example: type: bad_gateway errors: [] '503': description: Service Unavailable content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Service Unavailable example: type: service_unavailable errors: [] '504': description: Gateway Timeout content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Gateway Timeout example: type: gateway_timeout errors: [] /billing_documents: get: operationId: getBillingDocuments summary: List billing documents tags: - Billing Documents description: >- Returns a dictionary with a data property that contains an array of billing documents, starting after cursor. Each entry in the array is a separate billing document object. If no more billing documents are available, the resulting array will be empty. This request should never return an error. parameters: - in: query name: cursor required: false schema: type: string x-java-sdk-legacy-param: true 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 x-java-sdk-legacy-param: true items: type: string description: >- Allows you to expand responses by including related object information in a single call. See the [Expand responses](https://developer.zuora.com/quickstart-api/tutorial/expand-responses/) section of the Quickstart API Tutorials for detailed instructions. - in: query name: filter[] required: false schema: type: array x-java-sdk-legacy-param: true items: type: string description: >- A case-sensitive filter on the list. See the [Filter lists](https://developer.zuora.com/quickstart-api/tutorial/filter-lists/) section of the Quickstart API Tutorials for detailed instructions. - in: query name: sort[] required: false schema: type: array x-java-sdk-legacy-param: false items: type: string description: >- A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `account_number.asc`) or descending (e.g. `account_number.desc`). You cannot sort on properties that are arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. - in: query name: page_size required: false schema: type: integer x-java-sdk-legacy-param: false minimum: 1 maximum: 99 description: >- The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `account_id`, `balance`, `description`, `state`, `tax`
- in: query name: billing_document_items.fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `price_id`, `discount_item`, `deferred_revenue_account`, `description`, `name`, `quantity`, `recognized_revenue_account`, `service_end`, `service_start`, `accounts_receivable_account`, `subscription_id`, `subscription_item_id`, `tax`, `tax_inclusive`, `unit_amount`
- in: query name: taxation_items.fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `amount`, `amount_exempt`, `tax_date`, `jurisdiction`, `location_code`, `name`, `sales_tax_payable_account`, `tax_code`, `tax_code_name`, `tax_rate`, `tax_rate_name`, `tax_inclusive`, `tax_rate_type`
- $ref: '#/components/parameters/zuora-track-id' - $ref: '#/components/parameters/zuora-entity-id' - $ref: '#/components/parameters/idempotency-key' - $ref: '#/components/parameters/accept-encoding' - $ref: '#/components/parameters/content-encoding' x-operation-type: list x-is-list-operation: true x-code-samples: - lang: Curl label: cURL source: >- curl -X GET "https://rest.sandbox.na.zuora.com/v2/billing_documents?expand%5B%5D=items&filter%5B%5D=type.EQ%3Ainvoice" -H "Authorization: Bearer 6d151216ef504f65b8ff6e9e9e8356d3" -H "Content-Type: application/json" - lang: Java label: Java source: >- BillingDocumentListResponse billingDocumentListResponse = zuoraClient.billingDocuments().getBillingDocuments(Collections.singletonList("type.EQ:invoice"),Collections.singletonList("items"),null); System.out.println(billingDocumentListResponse); - lang: JavaScript label: Node source: >- const invoicesResponse = await zuoraClient.billingDocuments.getBillingDocuments({ filter:['type.EQ:invoice'], expand:['items'] }); console.log(invoicesResponse); x-group-parameters: true responses: '200': description: Default Response content: application/json: schema: $ref: '#/components/schemas/billingDocumentListResponse' headers: ratelimit-limit: description: >- The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information. schema: type: string ratelimit-remaining: description: >- The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information. schema: type: number ratelimit-reset: description: >- The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information. schema: type: number zuora-request-id: description: Zuora’s internal identifier for this request. schema: type: string zuora-track-id: description: >- A user-supplied identifier for this request. If you supply a `zuora-track-id` as a request header, Zuora returns the `zuora-track-id` as a response header. schema: type: string '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Bad Request example: type: bad_request errors: - code: invalid_parameter parameter: currency message: '''currency'' length must be between 3 and 3' retryable: false '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Unauthorized example: type: unauthorized errors: [] retryable: false '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Not Found example: type: not_found errors: - code: resource_not_found parameter: id message: >- Resource 2c92c0f974e9737a0175034cc0cc10c could not be found retryable: false '405': description: Method Not Allowed content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Method Not Allowed example: type: method_not_allowed retryable: false errors: [] '429': description: Too Many Requests content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Too Many Requests example: type: too_many_requests errors: [] '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Internal Server Error example: type: internal_server_error errors: [] '502': description: Bad Gateway content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Bad Gateway example: type: bad_gateway errors: [] '503': description: Service Unavailable content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Service Unavailable example: type: service_unavailable errors: [] '504': description: Gateway Timeout content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Gateway Timeout example: type: gateway_timeout errors: [] post: operationId: postBillingDocument summary: Create a billing document tags: - Billing Documents description: >- Creates different types of billing document objects, including invoices, credit memos, and debit memos. requestBody: content: application/json: schema: $ref: '#/components/schemas/billingDocumentCreateRequest' example: accountId: 2c92c0f96abc17de016abd62bd0c5854 pay: false description: comments documentDate: '2020-02-01' type: invoice post: true items: - amount: 300 bookingReference: bookingReference itemDate: 1580544000000 subscriptionItemName: charge with tax amount 9 description: description quantity: 2 serviceEnd: '2020-02-10' serviceStart: '2020-02-01' required: true parameters: - in: query name: fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `account_id`, `balance`, `description`, `state`, `tax`
- in: query name: billing_document_items.fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `price_id`, `discount_item`, `deferred_revenue_account`, `description`, `name`, `quantity`, `recognized_revenue_account`, `service_end`, `service_start`, `accounts_receivable_account`, `subscription_id`, `subscription_item_id`, `tax`, `tax_inclusive`, `unit_amount`
- in: query name: taxation_items.fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `amount`, `amount_exempt`, `tax_date`, `jurisdiction`, `location_code`, `name`, `sales_tax_payable_account`, `tax_code`, `tax_code_name`, `tax_rate`, `tax_rate_name`, `tax_inclusive`, `tax_rate_type`
- in: query name: expand[] required: false schema: type: array x-java-sdk-legacy-param: true items: type: string description: >- Allows you to expand responses by including related object information in a single call. See the [Expand responses](https://developer.zuora.com/quickstart-api/tutorial/expand-responses/) section of the Quickstart API Tutorials for detailed instructions. - in: query name: filter[] required: false schema: type: array x-java-sdk-legacy-param: false items: type: string description: >- A case-sensitive filter on the list. See the [Filter lists](https://developer.zuora.com/quickstart-api/tutorial/filter-lists/) section of the Quickstart API Tutorial for detailed instructions. Note that the filters on this operation are only applicable to the related objects. For example, when you are calling the "Retrieve a billing document" operation, you can use the `filter[]` parameter on the related objects such as `filter[]=items[account_id].EQ:8ad09e208858b5cf0188595208151c63` - in: query name: page_size required: false schema: type: integer x-java-sdk-legacy-param: false minimum: 1 maximum: 99 description: >- The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 99, Zuora will return a 400 error. - $ref: '#/components/parameters/zuora-track-id' - $ref: '#/components/parameters/async' - $ref: '#/components/parameters/zuora-entity-id' - $ref: '#/components/parameters/idempotency-key' - $ref: '#/components/parameters/accept-encoding' - $ref: '#/components/parameters/content-encoding' x-operation-type: create x-code-samples: - lang: Curl label: cURL source: >- curl --request POST --url https://rest.apisandbox.zuora.com/v2/billing_documents --header 'Authorization: Bearer 7676db88e1a84293a6298c8d44cc141c' --header 'Content-Type: application/json' --data '{ "account_id": "8ad08ccf806f42ed018090759555446b", "pay": false, "description": "new invoice", "document_date": "2022-09-01", "type": "invoice", "post":true, "items": [ { "amount": 300, "booking_reference": "PE2FGW", "subscription_item_name": "a subscription item inclusive of tax", "description": "A new invoice item", "quantity": 2, "service_end": "2023-09-01", "service_start": "2022-09-01" } ] }' - lang: Java label: Java source: >2- LocalDate todayDate = LocalDate.now(); BillingDocumentItemCreateRequest invoiceItemRequest = new BillingDocumentItemCreateRequest() .amount(new BigDecimal(10.25)) .bookingReference("PE2FGW") .subscriptionItemName("subscription item 1") .description("a new invoice item") .quantity(new BigDecimal(2)) .serviceEnd("2023-09-01") .serviceStart("2022-09-01"); BillingDocumentCreateRequest invoiceRequest = new BillingDocumentCreateRequest() .accountId("8ad09c4b8262e38101826441928c1162") .pay(false) .description("new invoice") .documentDate(todayDate) .type(BillingDocumentCreateRequest.TypeEnum.INVOICE) .post(false) .items(Collections.singletonList(invoiceItemRequest)); BillingDocument newInvoice = zuoraClient.billingDocuments().postBillingDocument(invoiceRequest); - lang: JavaScript label: Node source: "\nconst billingDocItems = [{\n amount:100,\n booking_reference: 'PE2FGW',\t\n name: 'subscription item 1',\n description: 'a new invoice item',\n service_end: '2023-09-01',\n service_start: '2022-09-01',\n}];\n \nconst invoiceRequest = {\n account_id: '2c92c0f96abc17de016abd62bd0c5854',\n pay: false,\n description: 'new invoice',\n document_date: '2022-09-01',\n type: 'invoice',\n post: true,\n items: billingDocItems,\n};\n \nconst newInvoice = await zuoraClient.billingDocuments.postBillingDocument(invoiceRequest);\n " x-group-parameters: true responses: '201': description: Default Response content: application/json: schema: $ref: '#/components/schemas/billingDocument' example: id: 8ad09b7d82d9662c0182daeaa9f4477e billing_document_number: INV00006723 created_by_id: 2c92c0946a6dffc0016a7faab604299b updated_by_id: 2c92c0946a6dffc0016a7faab604299b created_time: '2022-08-26T09:09:48-07:00' updated_time: '2022-08-26T09:09:48-07:00' posted_by_id: 2c92c0946a6dffc0016a7faab604299b state_transitions: posted_at: '2022-08-26T09:09:48-07:00' type: invoice state: open account_id: 2c92c0f86a8dd422016a9e7a70116b0d items: next_page: null data: - type: invoice amount: 10 created_by_id: 2c92c0946a6dffc0016a7faab604299b discount_item: false created_time: '2022-08-26T09:09:48-07:00' custom_fields: field__c: custom field value document_item_date: '2022-08-26T09:09:48-07:00' id: 8ad09b7d82d9662c0182daeaaa114781 sku: SKU-00011672 price_name: aaaaaa quantity: 1 remaining_balance: 10 revenue_recognition_rule_name: Recognize upon invoicing service_end: '2022-08-23' service_start: '2022-08-23' tax: 1.5 tax_inclusive: false unit_amount: 0 updated_by_id: 2c92c0946a6dffc0016a7faab604299b total: 11.5 subtotal: 10 tax: 1.5 remaining_balance: 11.5 amount_paid: 0 paid: false past_due: false document_date: '2022-08-23' due_date: '2022-09-22' custom_fields: field__c: custom field value amount_refunded: 0 headers: ratelimit-limit: description: >- The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information. schema: type: string ratelimit-remaining: description: >- The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information. schema: type: number ratelimit-reset: description: >- The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information. schema: type: number zuora-request-id: description: Zuora’s internal identifier for this request. schema: type: string zuora-track-id: description: >- A user-supplied identifier for this request. If you supply a `zuora-track-id` as a request header, Zuora returns the `zuora-track-id` as a response header. schema: type: string '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Bad Request example: type: bad_request errors: - code: invalid_parameter parameter: currency message: '''currency'' length must be between 3 and 3' retryable: false '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Unauthorized example: type: unauthorized errors: [] retryable: false '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Not Found example: type: not_found errors: - code: resource_not_found parameter: id message: >- Resource 2c92c0f974e9737a0175034cc0cc10c could not be found retryable: false '405': description: Method Not Allowed content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Method Not Allowed example: type: method_not_allowed retryable: false errors: [] '429': description: Too Many Requests content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Too Many Requests example: type: too_many_requests errors: [] '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Internal Server Error example: type: internal_server_error errors: [] '502': description: Bad Gateway content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Bad Gateway example: type: bad_gateway errors: [] '503': description: Service Unavailable content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Service Unavailable example: type: service_unavailable errors: [] '504': description: Gateway Timeout content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Gateway Timeout example: type: gateway_timeout errors: [] /billing_document_items: get: operationId: getBillingDocumentItems summary: List billing document items tags: - Billing Document Items description: List billing document items parameters: - in: query name: cursor required: false schema: type: string x-java-sdk-legacy-param: true 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 x-java-sdk-legacy-param: true items: type: string description: >- Allows you to expand responses by including related object information in a single call. See the [Expand responses](https://developer.zuora.com/quickstart-api/tutorial/expand-responses/) section of the Quickstart API Tutorials for detailed instructions. - in: query name: filter[] required: false schema: type: array x-java-sdk-legacy-param: true items: type: string description: >- A case-sensitive filter on the list. See the [Filter lists](https://developer.zuora.com/quickstart-api/tutorial/filter-lists/) section of the Quickstart API Tutorials for detailed instructions. - in: query name: sort[] required: false schema: type: array x-java-sdk-legacy-param: false items: type: string description: >- A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `account_number.asc`) or descending (e.g. `account_number.desc`). You cannot sort on properties that are arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. - in: query name: page_size required: false schema: type: integer x-java-sdk-legacy-param: false minimum: 1 maximum: 99 description: >- The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `price_id`, `discount_item`, `deferred_revenue_account`, `description`, `name`, `quantity`, `recognized_revenue_account`, `service_end`, `service_start`, `accounts_receivable_account`, `subscription_id`, `subscription_item_id`, `tax`, `tax_inclusive`, `unit_amount`
- in: query name: taxation_items.fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `amount`, `amount_exempt`, `tax_date`, `jurisdiction`, `location_code`, `name`, `sales_tax_payable_account`, `tax_code`, `tax_code_name`, `tax_rate`, `tax_rate_name`, `tax_inclusive`, `tax_rate_type`
- $ref: '#/components/parameters/zuora-track-id' - $ref: '#/components/parameters/zuora-entity-id' - $ref: '#/components/parameters/idempotency-key' - $ref: '#/components/parameters/accept-encoding' - $ref: '#/components/parameters/content-encoding' x-operation-type: list x-is-list-operation: true x-code-samples: - lang: Curl label: cURL source: > curl -X GET "https://rest.sandbox.na.zuora.com/v2/billing_document_items?expand%5B%5D=subscription_item&filter%5B%5D=type.EQ%3Acredit_memo" -H "Authorization: Bearer 6d151216ef504f65b8ff6e9e9e8356d3" -H "Content-Type: application/json" - lang: Java label: Java source: >- BillingDocumentItemListResponse billingDocItemListResponse = zuoraClient.billingDocuments().getBillingDocumentItems(Collections.singletonList("type.EQ:credit_memo"), Collections.singletonList("subscription_item"), null); System.out.println(billingDocItemListResponse); - lang: JavaScript label: Node source: >- const billingDocItemsResponse = await zuoraClient.billingDocumentItems.getBillingDocumentItems({ filter:['type.EQ:credit_memo'], expand: ['subscription_item'], }); console.log(billingDocItemsResponse); x-group-parameters: true responses: '200': description: Default Response content: application/json: schema: $ref: '#/components/schemas/billingDocumentItemListResponse' headers: ratelimit-limit: description: >- The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information. schema: type: string ratelimit-remaining: description: >- The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information. schema: type: number ratelimit-reset: description: >- The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information. schema: type: number zuora-request-id: description: Zuora’s internal identifier for this request. schema: type: string zuora-track-id: description: >- A user-supplied identifier for this request. If you supply a `zuora-track-id` as a request header, Zuora returns the `zuora-track-id` as a response header. schema: type: string '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Bad Request example: type: bad_request errors: - code: invalid_parameter parameter: currency message: '''currency'' length must be between 3 and 3' retryable: false '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Unauthorized example: type: unauthorized errors: [] retryable: false '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Not Found example: type: not_found errors: - code: resource_not_found parameter: id message: >- Resource 2c92c0f974e9737a0175034cc0cc10c could not be found retryable: false '405': description: Method Not Allowed content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Method Not Allowed example: type: method_not_allowed retryable: false errors: [] '429': description: Too Many Requests content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Too Many Requests example: type: too_many_requests errors: [] '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Internal Server Error example: type: internal_server_error errors: [] '502': description: Bad Gateway content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Bad Gateway example: type: bad_gateway errors: [] '503': description: Service Unavailable content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Service Unavailable example: type: service_unavailable errors: [] '504': description: Gateway Timeout content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Gateway Timeout example: type: gateway_timeout errors: [] /contacts/{contact_id}: get: operationId: getContact summary: Retrieve a contact tags: - Contacts description: Retrieves the contact with the given ID. parameters: - in: query name: fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `account_id`, `address`, `home_phone`, `first_name`, `last_name`, `email`, `work_email`, `nickname`, `other_phone`, `work_phone`, `mobile_phone`, `tax_region`, `other_phone_type`, `fax`
- in: query name: expand[] required: false schema: type: array x-java-sdk-legacy-param: true items: type: string description: >- Allows you to expand responses by including related object information in a single call. See the [Expand responses](https://developer.zuora.com/quickstart-api/tutorial/expand-responses/) section of the Quickstart API Tutorials for detailed instructions. - in: query name: filter[] required: false schema: type: array x-java-sdk-legacy-param: false items: type: string description: >- A case-sensitive filter on the list. See the [Filter lists](https://developer.zuora.com/quickstart-api/tutorial/filter-lists/) section of the Quickstart API Tutorial for detailed instructions. Note that the filters on this operation are only applicable to the related objects. For example, when you are calling the "Retrieve a billing document" operation, you can use the `filter[]` parameter on the related objects such as `filter[]=items[account_id].EQ:8ad09e208858b5cf0188595208151c63` - in: query name: page_size required: false schema: type: integer x-java-sdk-legacy-param: false minimum: 1 maximum: 99 description: >- The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 99, Zuora will return a 400 error. - in: path name: contact_id required: true schema: type: string description: Contact Id - $ref: '#/components/parameters/zuora-track-id' - $ref: '#/components/parameters/zuora-entity-id' - $ref: '#/components/parameters/idempotency-key' - $ref: '#/components/parameters/accept-encoding' - $ref: '#/components/parameters/content-encoding' x-operation-type: get x-code-samples: - lang: Curl label: cURL source: > curl --request GET --url https://rest.apisandbox.zuora.com/v2/contacts/8ad08c0f7d0972ea017d0a705e8059ba --header 'Authorization: Bearer 08dacd3fe8b648f6861d5eb506d02a86' --header 'Content-Type: application/json' - lang: Java label: Java source: >- Contact contactResponse = zuoraClient.contact().getContact(contact.getId()); System.out.println(contactResponse); - lang: JavaScript label: Node source: >- const contactResponse = await zuoraClient.contacts.getContact('8ad09bce844283060184475e7ee669f0'); console.log(contactResponse); x-group-parameters: true responses: '200': description: Default Response content: application/json: schema: $ref: '#/components/schemas/contact' example: id: 8ad08ccf8437067601843a7af4e64rq3 updated_by_id: 2c92c0946a6dffc0016a7faab604299b updated_time: '2022-08-03T13:23:21-07:00' created_by_id: 2c92c0946a6dffc0016a7faab604299b created_time: '2022-08-03T13:23:21-07:00' custom_fields: field__c: custom field value account_id: 8ad085518262bc17018265525eab3696 address: line1: 101 Redwood Shores Parkway line2: Suite 1150 city: Redwood City state: California country: United States postal_code: '94065' first_name: Amy last_name: Lawrence work_email: amy.lawrence@gmail.com work_phone: (888) 976-9056 headers: ratelimit-limit: description: >- The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information. schema: type: string ratelimit-remaining: description: >- The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information. schema: type: number ratelimit-reset: description: >- The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information. schema: type: number zuora-request-id: description: Zuora’s internal identifier for this request. schema: type: string zuora-track-id: description: >- A user-supplied identifier for this request. If you supply a `zuora-track-id` as a request header, Zuora returns the `zuora-track-id` as a response header. schema: type: string '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Bad Request example: type: bad_request errors: - code: invalid_parameter parameter: currency message: '''currency'' length must be between 3 and 3' retryable: false '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Unauthorized example: type: unauthorized errors: [] retryable: false '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Not Found example: type: not_found errors: - code: resource_not_found parameter: id message: >- Resource 2c92c0f974e9737a0175034cc0cc10c could not be found retryable: false '405': description: Method Not Allowed content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Method Not Allowed example: type: method_not_allowed retryable: false errors: [] '429': description: Too Many Requests content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Too Many Requests example: type: too_many_requests errors: [] '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Internal Server Error example: type: internal_server_error errors: [] '502': description: Bad Gateway content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Bad Gateway example: type: bad_gateway errors: [] '503': description: Service Unavailable content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Service Unavailable example: type: service_unavailable errors: [] '504': description: Gateway Timeout content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Gateway Timeout example: type: gateway_timeout errors: [] patch: operationId: updateContact summary: Update a contact tags: - Contacts description: >- Updates the specified contact by setting the values of the parameters passed. Any parameters not provided will be left unchanged. requestBody: content: application/json: schema: $ref: '#/components/schemas/contactPatchRequest' example: first_name: James last_name: Lawrence required: true parameters: - in: query name: fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `account_id`, `address`, `home_phone`, `first_name`, `last_name`, `email`, `work_email`, `nickname`, `other_phone`, `work_phone`, `mobile_phone`, `tax_region`, `other_phone_type`, `fax`
- in: query name: expand[] required: false schema: type: array x-java-sdk-legacy-param: true items: type: string description: >- Allows you to expand responses by including related object information in a single call. See the [Expand responses](https://developer.zuora.com/quickstart-api/tutorial/expand-responses/) section of the Quickstart API Tutorials for detailed instructions. - in: query name: filter[] required: false schema: type: array x-java-sdk-legacy-param: false items: type: string description: >- A case-sensitive filter on the list. See the [Filter lists](https://developer.zuora.com/quickstart-api/tutorial/filter-lists/) section of the Quickstart API Tutorial for detailed instructions. Note that the filters on this operation are only applicable to the related objects. For example, when you are calling the "Retrieve a billing document" operation, you can use the `filter[]` parameter on the related objects such as `filter[]=items[account_id].EQ:8ad09e208858b5cf0188595208151c63` - in: query name: page_size required: false schema: type: integer x-java-sdk-legacy-param: false minimum: 1 maximum: 99 description: >- The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 99, Zuora will return a 400 error. - in: path name: contact_id required: true schema: type: string description: Contact Id - $ref: '#/components/parameters/zuora-track-id' - $ref: '#/components/parameters/async' - $ref: '#/components/parameters/zuora-entity-id' - $ref: '#/components/parameters/idempotency-key' - $ref: '#/components/parameters/accept-encoding' - $ref: '#/components/parameters/content-encoding' x-operation-type: update x-code-samples: - lang: Curl label: cURL source: >- curl --request PATCH --url https://rest.apisandbox.zuora.com/v2/contacts/8ad08c0f7d0972ea017d0a705e8059ba --header 'Authorization: Bearer 8e8a7aec6fa4476d97a52b52dc3cc52f' --header 'Content-Type: application/json' --data '{ "address": { "line1": "No.123, the 45th steet", "postal_code": "98101", "city": "Seattle", "state": "Washington", "country": "USA" } }' - lang: Java label: Java source: >- Contact oldContact = zuoraClient.contact().getContact("8ad0991582aa848e0182ae9dad214dd0"); ContactPatchRequest contactPatchRequest = new ContactPatchRequest() .address(new Address() .country("USA") .state("CA")); Contact updatedContact = zuoraClient.contact().updateContact(oldContact.getId(),contactPatchRequest); - lang: JavaScript label: Node source: >- const contactId = newContact.id; const contactPatchRequest = { address: { country: 'USA', state: 'CA' } }; const updatedContact = await zuoraClient.contacts.updateContact(contactId, contactPatchRequest); x-group-parameters: true responses: '200': description: Default Response content: application/json: schema: $ref: '#/components/schemas/contact' example: id: 8ad08e018262bc2b018265608a3e10e6 updated_by_id: 2c92c0946a6dffc0016a7faab604299b updated_time: '2022-08-03T13:27:21-07:00' created_by_id: 2c92c0946a6dffc0016a7faab604299b created_time: '2022-08-03T13:23:21-07:00' custom_fields: field__c: custom field value account_id: 8ad085518262bc17018265525eab3696 address: line1: 101 Redwood Shores Parkway line2: Suite 1150 city: Redwood City state: California country: United States postal_code: '94065' first_name: James last_name: Lawrence work_email: amy.lawrence@gmail.com work_phone: (888) 976-9056 headers: ratelimit-limit: description: >- The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information. schema: type: string ratelimit-remaining: description: >- The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information. schema: type: number ratelimit-reset: description: >- The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information. schema: type: number zuora-request-id: description: Zuora’s internal identifier for this request. schema: type: string zuora-track-id: description: >- A user-supplied identifier for this request. If you supply a `zuora-track-id` as a request header, Zuora returns the `zuora-track-id` as a response header. schema: type: string '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Bad Request example: type: bad_request errors: - code: invalid_parameter parameter: currency message: '''currency'' length must be between 3 and 3' retryable: false '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Unauthorized example: type: unauthorized errors: [] retryable: false '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Not Found example: type: not_found errors: - code: resource_not_found parameter: id message: >- Resource 2c92c0f974e9737a0175034cc0cc10c could not be found retryable: false '405': description: Method Not Allowed content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Method Not Allowed example: type: method_not_allowed retryable: false errors: [] '429': description: Too Many Requests content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Too Many Requests example: type: too_many_requests errors: [] '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Internal Server Error example: type: internal_server_error errors: [] '502': description: Bad Gateway content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Bad Gateway example: type: bad_gateway errors: [] '503': description: Service Unavailable content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Service Unavailable example: type: service_unavailable errors: [] '504': description: Gateway Timeout content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Gateway Timeout example: type: gateway_timeout errors: [] delete: operationId: deleteContact summary: Delete a contact tags: - Contacts description: Permanently deletes a contact. It cannot be undone. parameters: - in: path name: contact_id required: true schema: type: string description: Contact Id - $ref: '#/components/parameters/zuora-track-id' - $ref: '#/components/parameters/async' - $ref: '#/components/parameters/zuora-entity-id' - $ref: '#/components/parameters/idempotency-key' - $ref: '#/components/parameters/accept-encoding' - $ref: '#/components/parameters/content-encoding' x-operation-type: delete x-code-samples: - lang: Curl label: cURL source: >- curl --request DELETE --url 'https://rest.apisandbox.zuora.com/v2/contacts/8ad08c0f7d0972ea017d0a705e8059ba' --header 'Authorization: Bearer 08dacd3fe8b648f6861d5eb506d02a86' --header 'Content-Type: application/json' - lang: Java label: Java source: >- SuccessResponse result = zuoraClient.contact().deleteContact(createdContact.getId()); System.out.println(result); - lang: JavaScript label: Node source: >- const contactDeleteResponse = await zuoraClient.contacts.deleteContact('8ad09bce844283060184475e7ee669f0'); console.log(contactDeleteResponse); x-group-parameters: true responses: '204': description: Default Response headers: ratelimit-limit: description: >- The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information. schema: type: string ratelimit-remaining: description: >- The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information. schema: type: number ratelimit-reset: description: >- The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information. schema: type: number zuora-request-id: description: Zuora’s internal identifier for this request. schema: type: string zuora-track-id: description: >- A user-supplied identifier for this request. If you supply a `zuora-track-id` as a request header, Zuora returns the `zuora-track-id` as a response header. schema: type: string '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Bad Request example: type: bad_request errors: - code: invalid_parameter parameter: currency message: '''currency'' length must be between 3 and 3' retryable: false '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Unauthorized example: type: unauthorized errors: [] retryable: false '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Not Found example: type: not_found errors: - code: resource_not_found parameter: id message: >- Resource 2c92c0f974e9737a0175034cc0cc10c could not be found retryable: false '405': description: Method Not Allowed content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Method Not Allowed example: type: method_not_allowed retryable: false errors: [] '429': description: Too Many Requests content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Too Many Requests example: type: too_many_requests errors: [] '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Internal Server Error example: type: internal_server_error errors: [] '502': description: Bad Gateway content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Bad Gateway example: type: bad_gateway errors: [] '503': description: Service Unavailable content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Service Unavailable example: type: service_unavailable errors: [] '504': description: Gateway Timeout content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Gateway Timeout example: type: gateway_timeout errors: [] /contacts: get: operationId: getContacts summary: List contacts tags: - Contacts description: >- Returns a dictionary with a data property that contains an array of contacts, starting after the cursor, if used. Each entry in the array is a separate contact object. If no more contacts are available, the resulting array will be empty. This request should never return an error. parameters: - in: query name: cursor required: false schema: type: string x-java-sdk-legacy-param: true 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 x-java-sdk-legacy-param: true items: type: string description: >- Allows you to expand responses by including related object information in a single call. See the [Expand responses](https://developer.zuora.com/quickstart-api/tutorial/expand-responses/) section of the Quickstart API Tutorials for detailed instructions. - in: query name: filter[] required: false schema: type: array x-java-sdk-legacy-param: true items: type: string description: >- A case-sensitive filter on the list. See the [Filter lists](https://developer.zuora.com/quickstart-api/tutorial/filter-lists/) section of the Quickstart API Tutorials for detailed instructions. - in: query name: sort[] required: false schema: type: array x-java-sdk-legacy-param: false items: type: string description: >- A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `account_number.asc`) or descending (e.g. `account_number.desc`). You cannot sort on properties that are arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored. - in: query name: page_size required: false schema: type: integer x-java-sdk-legacy-param: false minimum: 1 maximum: 99 description: >- The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 99, Zuora will return a 400 error. - in: query name: fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `account_id`, `address`, `home_phone`, `first_name`, `last_name`, `email`, `work_email`, `nickname`, `other_phone`, `work_phone`, `mobile_phone`, `tax_region`, `other_phone_type`, `fax`
- $ref: '#/components/parameters/zuora-track-id' - $ref: '#/components/parameters/zuora-entity-id' - $ref: '#/components/parameters/idempotency-key' - $ref: '#/components/parameters/accept-encoding' - $ref: '#/components/parameters/content-encoding' x-operation-type: list x-is-list-operation: true x-code-samples: - lang: Curl label: cURL source: >- curl --request GET --url 'https://rest.apisandbox.zuora.com/v2/contacts' --header 'Authorization: Bearer 08dacd3fe8b648f6861d5eb506d02a86' --header 'Content-Type: application/json' - lang: Java label: Java source: >- ListContactResponse contactListResponse = zuoraClient.contact().getContacts(null,null,null,null); System.out.println(contactListResponse); - lang: JavaScript label: Node source: |- const contactsResponse = await zuoraClient.contacts.getContacts({ filter: [ "first_name.SW:A" ]}) console.log(contactsResponse); x-group-parameters: true responses: '200': description: Default Response content: application/json: schema: $ref: '#/components/schemas/listContactResponse' example: next_page: >- W3sib3JkZXJCeSI6eyJmaWVsZCI6IlVwZGF0ZWREYXRlIiwib3JkZXIiOiJERVNDIn0sInZhbHVlIjoiMjAyMi0xMi0yMFQxMjoyODo1NC0wODowMCJ9LHsib3JkZXJCeSI6eyJmaWVsZCI6IklkIiwib3JkZXIiOiJERVNDIn0sInZhbHVlIjoiMmM5MmMwZjk2YWJjMTdkZTAxNmFiZDYyYmQwYzU4NTQifV0= data: - id: 8ad08ccf8437067601843a7af4e64rq3 updated_by_id: 2c92c0946a6dffc0016a7faab604299b updated_time: '2022-08-03T13:23:21-07:00' created_by_id: 2c92c0946a6dffc0016a7faab604299b created_time: '2022-08-03T13:23:21-07:00' custom_fields: field__c: custom field value account_id: 8ad085518262bc17018265525eab3696 address: line1: 101 Redwood Shores Parkway line2: Suite 1150 city: Redwood City state: California country: United States postal_code: '94065' first_name: Amy last_name: Lawrence work_email: amy.lawrence@gmail.com work_phone: (888) 976-9056 - id: 8ad08ccf8437067601843a7af4e64rq3 updated_by_id: 2c92c0946a6dffc0016a7faab604299b updated_time: '2022-08-03T13:23:21-07:00' created_by_id: 2c92c0946a6dffc0016a7faab604299b created_time: '2022-08-03T13:23:21-07:00' custom_fields: field__c: custom field value account_id: 8ad085518262bc17018265525eab3696 address: line1: 101 Redwood Shores Parkway line2: Suite 1150 city: Redwood City state: California country: United States postal_code: '94065' first_name: Amy last_name: Lawrence work_email: amy.lawrence@gmail.com work_phone: (888) 976-9056 - id: 8ad08ccf8437067601843a7af4e64rq3 updated_by_id: 2c92c0946a6dffc0016a7faab604299b updated_time: '2022-08-03T13:23:21-07:00' created_by_id: 2c92c0946a6dffc0016a7faab604299b created_time: '2022-08-03T13:23:21-07:00' custom_fields: field__c: custom field value account_id: 8ad085518262bc17018265525eab3696 address: line1: 101 Redwood Shores Parkway line2: Suite 1150 city: Redwood City state: California country: United States postal_code: '94065' first_name: Amy last_name: Lawrence work_email: amy.lawrence@gmail.com work_phone: (888) 976-9056 - id: 8ad08ccf8437067601843a7af4e64rq3 updated_by_id: 2c92c0946a6dffc0016a7faab604299b updated_time: '2022-08-03T13:23:21-07:00' created_by_id: 2c92c0946a6dffc0016a7faab604299b created_time: '2022-08-03T13:23:21-07:00' custom_fields: field__c: custom field value account_id: 8ad085518262bc17018265525eab3696 address: line1: 101 Redwood Shores Parkway line2: Suite 1150 city: Redwood City state: California country: United States postal_code: '94065' first_name: Amy last_name: Lawrence work_email: amy.lawrence@gmail.com work_phone: (888) 976-9056 - id: 8ad08ccf8437067601843a7af4e64rq3 updated_by_id: 2c92c0946a6dffc0016a7faab604299b updated_time: '2022-08-03T13:23:21-07:00' created_by_id: 2c92c0946a6dffc0016a7faab604299b created_time: '2022-08-03T13:23:21-07:00' custom_fields: field__c: custom field value account_id: 8ad085518262bc17018265525eab3696 address: line1: 101 Redwood Shores Parkway line2: Suite 1150 city: Redwood City state: California country: United States postal_code: '94065' first_name: Amy last_name: Lawrence work_email: amy.lawrence@gmail.com work_phone: (888) 976-9056 headers: ratelimit-limit: description: >- The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information. schema: type: string ratelimit-remaining: description: >- The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information. schema: type: number ratelimit-reset: description: >- The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information. schema: type: number zuora-request-id: description: Zuora’s internal identifier for this request. schema: type: string zuora-track-id: description: >- A user-supplied identifier for this request. If you supply a `zuora-track-id` as a request header, Zuora returns the `zuora-track-id` as a response header. schema: type: string '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Bad Request example: type: bad_request errors: - code: invalid_parameter parameter: currency message: '''currency'' length must be between 3 and 3' retryable: false '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Unauthorized example: type: unauthorized errors: [] retryable: false '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Not Found example: type: not_found errors: - code: resource_not_found parameter: id message: >- Resource 2c92c0f974e9737a0175034cc0cc10c could not be found retryable: false '405': description: Method Not Allowed content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Method Not Allowed example: type: method_not_allowed retryable: false errors: [] '429': description: Too Many Requests content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Too Many Requests example: type: too_many_requests errors: [] '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Internal Server Error example: type: internal_server_error errors: [] '502': description: Bad Gateway content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Bad Gateway example: type: bad_gateway errors: [] '503': description: Service Unavailable content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Service Unavailable example: type: service_unavailable errors: [] '504': description: Gateway Timeout content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Gateway Timeout example: type: gateway_timeout errors: [] post: operationId: createContact summary: Create a contact tags: - Contacts description: Creates a new contact object. requestBody: content: application/json: schema: $ref: '#/components/schemas/contactCreateRequest' example: account_id: 8ad085518262bc17018265525eab3696 first_name: Amy last_name: Lawrence address: line1: 101 Redwood Shores Parkway line2: Suite 1150 city: Redwood City state: California country: USA postal_code: '94065' work_phone: (888) 976-9056 work_email: amy.lawrence@gmail.com required: true parameters: - in: query name: fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `account_id`, `address`, `home_phone`, `first_name`, `last_name`, `email`, `work_email`, `nickname`, `other_phone`, `work_phone`, `mobile_phone`, `tax_region`, `other_phone_type`, `fax`
- in: query name: expand[] required: false schema: type: array x-java-sdk-legacy-param: true items: type: string description: >- Allows you to expand responses by including related object information in a single call. See the [Expand responses](https://developer.zuora.com/quickstart-api/tutorial/expand-responses/) section of the Quickstart API Tutorials for detailed instructions. - in: query name: filter[] required: false schema: type: array x-java-sdk-legacy-param: false items: type: string description: >- A case-sensitive filter on the list. See the [Filter lists](https://developer.zuora.com/quickstart-api/tutorial/filter-lists/) section of the Quickstart API Tutorial for detailed instructions. Note that the filters on this operation are only applicable to the related objects. For example, when you are calling the "Retrieve a billing document" operation, you can use the `filter[]` parameter on the related objects such as `filter[]=items[account_id].EQ:8ad09e208858b5cf0188595208151c63` - in: query name: page_size required: false schema: type: integer x-java-sdk-legacy-param: false minimum: 1 maximum: 99 description: >- The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 99, Zuora will return a 400 error. - $ref: '#/components/parameters/zuora-track-id' - $ref: '#/components/parameters/async' - $ref: '#/components/parameters/zuora-entity-id' - $ref: '#/components/parameters/idempotency-key' - $ref: '#/components/parameters/accept-encoding' - $ref: '#/components/parameters/content-encoding' x-operation-type: create x-code-samples: - lang: Curl label: cURL source: >- curl --request POST --url https://rest.apisandbox.zuora.com/v2/contacts --header 'Authorization: Bearer d71a4363b94f42bca6e1453892818775' --header 'Content-Type: application/json' --data '{ "account_id": "2c92c0f86cbe335a016cbece4a434ada", "first_name": "Amy", "last_name": "Lawrence" }' - lang: Java label: Java source: >- ContactCreateRequest contactCreateRequest = new ContactCreateRequest() .accountId(account.getId()) .firstName("Amy") .lastName("Lawrence"); Contact contact = zuoraClient.contact().createContact(contactCreateRequest); - lang: JavaScript label: Node source: >- const contactCreateRequest = { account_id: '2c92c0f86cbe335a016cbece4a434ada', first_name: 'Amy', last_name: 'Lawrence' }; const newContact = await zuoraClient.contacts.createContact(contactCreateRequest); x-group-parameters: true responses: '201': description: Default Response content: application/json: schema: $ref: '#/components/schemas/contact' example: id: 8ad08ccf8437067601843a7af4e64rq3 updated_by_id: 2c92c0946a6dffc0016a7faab604299b updated_time: '2022-08-03T13:23:21-07:00' created_by_id: 2c92c0946a6dffc0016a7faab604299b created_time: '2022-08-03T13:23:21-07:00' custom_fields: field__c: custom field value account_id: 8ad085518262bc17018265525eab3696 address: line1: 101 Redwood Shores Parkway line2: Suite 1150 city: Redwood City state: California country: United States postal_code: '94065' first_name: Amy last_name: Lawrence work_email: amy.lawrence@gmail.com work_phone: (888) 976-9056 headers: ratelimit-limit: description: >- The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information. schema: type: string ratelimit-remaining: description: >- The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information. schema: type: number ratelimit-reset: description: >- The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information. schema: type: number zuora-request-id: description: Zuora’s internal identifier for this request. schema: type: string zuora-track-id: description: >- A user-supplied identifier for this request. If you supply a `zuora-track-id` as a request header, Zuora returns the `zuora-track-id` as a response header. schema: type: string '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Bad Request example: type: bad_request errors: - code: invalid_parameter parameter: currency message: '''currency'' length must be between 3 and 3' retryable: false '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Unauthorized example: type: unauthorized errors: [] retryable: false '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Not Found example: type: not_found errors: - code: resource_not_found parameter: id message: >- Resource 2c92c0f974e9737a0175034cc0cc10c could not be found retryable: false '405': description: Method Not Allowed content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Method Not Allowed example: type: method_not_allowed retryable: false errors: [] '429': description: Too Many Requests content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Too Many Requests example: type: too_many_requests errors: [] '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Internal Server Error example: type: internal_server_error errors: [] '502': description: Bad Gateway content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Bad Gateway example: type: bad_gateway errors: [] '503': description: Service Unavailable content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Service Unavailable example: type: service_unavailable errors: [] '504': description: Gateway Timeout content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Gateway Timeout example: type: gateway_timeout errors: [] /contacts/{contact_id}/scrub: post: operationId: scrubContact summary: Scrub a contact tags: - Contacts description: Scrubs the sensitive data for the contact with the given ID. parameters: - in: query name: fields[] required: false schema: type: array deprecated: false x-java-sdk-legacy-param: false x-java-sdk-fields-param: true items: type: string example: - id,created_time description: |- Allows you to specify which fields are returned in the response.
Accepted values `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `account_id`, `address`, `home_phone`, `first_name`, `last_name`, `email`, `work_email`, `nickname`, `other_phone`, `work_phone`, `mobile_phone`, `tax_region`, `other_phone_type`, `fax`
- in: query name: expand[] required: false schema: type: array x-java-sdk-legacy-param: true items: type: string description: >- Allows you to expand responses by including related object information in a single call. See the [Expand responses](https://developer.zuora.com/quickstart-api/tutorial/expand-responses/) section of the Quickstart API Tutorials for detailed instructions. - in: query name: filter[] required: false schema: type: array x-java-sdk-legacy-param: false items: type: string description: >- A case-sensitive filter on the list. See the [Filter lists](https://developer.zuora.com/quickstart-api/tutorial/filter-lists/) section of the Quickstart API Tutorial for detailed instructions. Note that the filters on this operation are only applicable to the related objects. For example, when you are calling the "Retrieve a billing document" operation, you can use the `filter[]` parameter on the related objects such as `filter[]=items[account_id].EQ:8ad09e208858b5cf0188595208151c63` - in: query name: page_size required: false schema: type: integer x-java-sdk-legacy-param: false minimum: 1 maximum: 99 description: >- The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 99, Zuora will return a 400 error. - in: path name: contact_id required: true schema: type: string description: Contact Id - in: header name: zuora-track-id required: false description: >- A custom identifier for tracking API requests. If you set a value for this header, Zuora returns the same value in the response header. This header enables you to track your API calls to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), or quote ('). schema: type: string - in: header name: async required: false description: >- Making asynchronous requests allows you to scale your applications more efficiently by leveraging Zuora's infrastructure to enqueue and execute requests for you without blocking. These requests also use built-in retry semantics, which makes them much less likely to fail for non-deterministic reasons, even in extreme high-throughput scenarios. Meanwhile, when you send a request to one of these endpoints, you can expect to receive a response in less than 150 milliseconds and these calls are unlikely to trigger rate limit errors. If set to true, Zuora returns a 202 Accepted response, and the response body contains only a request ID. schema: type: boolean - in: header name: zuora-entity-id required: false description: >- An entity ID. If you have multi-entity enabled and the authorization token is valid for more than one entity, you must use this header to specify which entity to perform the operation on. If the authorization token is only valid for a single entity, or you do not have multi-entity enabled, you do not need to set this header. schema: type: string - in: header name: idempotency-key required: false description: >- Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. This idempotency key should be a unique value, and the Zuora server identifies subsequent retries of the same request using this value. For more information, see [Idempotent Requests](https://developer.zuora.com/api-references/quickstart-api/tag/Idempotent-Requests/). schema: type: string - in: header name: accept-encoding required: false description: >- Include a `accept-encoding: gzip` header to compress responses, which can reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes. For more information about this header, see [Request and Response Compression](https://developer.zuora.com/api-references/quickstart-api/tag/Request-and-Response-Compression/). schema: type: string - in: header name: content-encoding required: false description: >- Include a `content-encoding: gzip` header to compress a request. Upload a gzipped file for the payload if you specify this header. For more information, see [Request and Response Compression](https://developer.zuora.com/api-references/quickstart-api/tag/Request-and-Response-Compression/). schema: type: string x-operation-type: scrub x-code-samples: - lang: Curl label: cURL source: >- curl --request POST --url 'https://rest.apisandbox.zuora.com/v2/contacts/8ad08c0f7d0972ea017d0a705e8059ba/scrub' --header 'Authorization: Bearer 08dacd3fe8b648f6861d5eb506d02a86' --header 'Content-Type: application/json' - lang: Java label: Java source: >- SuccessResponse result = zuoraClient.contact().scrubContact(createdContact.getId()); System.out.println(result); - lang: JavaScript label: Node source: >- const contactScrubResponse = await zuoraClient.contacts.scrubContact('8ad09bce844283060184475e7ee669f0'); console.log(contactScrubResponse); x-group-parameters: true responses: '204': description: Default Response '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Bad Request example: type: bad_request errors: - code: invalid_parameter parameter: currency message: '''currency'' length must be between 3 and 3' retryable: false '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Unauthorized example: type: unauthorized errors: [] retryable: false '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Not Found example: type: not_found errors: - code: resource_not_found parameter: id message: >- Resource 2c92c0f974e9737a0175034cc0cc10c could not be found retryable: false '405': description: Method Not Allowed content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Method Not Allowed example: type: method_not_allowed retryable: false errors: [] '429': description: Too Many Requests content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Too Many Requests example: type: too_many_requests errors: [] '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/errorResponse' description: Internal Server Error example: type: internal_server_error errors: [] '502': description: Bad Gateway content: application/json: schema: $ref: '#/components/schemas/errorResponse'