PUT /v1/payment-schedule-items/{item-id}

The unique ID of a payment schedule item.

Default value: "application/json"

Include the Content-Encoding: gzip header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.

The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

The minor version of the Zuora REST API. See Minor Version for information about REST API version control.

This header affects the availability of the following request fields:

• paymentId
• linkPayments
• unlinkPayments

This header affects the availability of the following response fields:

• paymentId

The value is in the Bearer {token} format where {token} is a valid OAuth token generated by calling Create an OAuth token.

An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.

Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.

The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails.

If the header is not set, the operation is performed in scope of the user's accessible orgs.

Include the Accept-Encoding: gzip header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.

If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a Content-Encoding header with the compression algorithm so that your client can decompress it.

Container for payments linked to the payment schedule item.

ID of the payment to be linked to the payment schedule item.

Note: This feild is version controlled. To enable this field, you must set zuora-version to equal or smaller than 336.0.

The scheduled date when the payment is processed.

ID of the payment method of the payment schedule item.

Container for the paymentOption items, which describe the transactional level rules for processing payments. Currently, only the Gateway Options type is supported.

Here is an example:

"paymentOption": [
  {
    "type": "GatewayOptions",
    "detail": {
      "SecCode":"WEB"
    }
  }
]

paymentOption of the payment schedule takes precedence over paymentOption of the payment schedule item.

The type of the payment option. Currently, only GatewayOptions is supported for specifying Gateway Options fields supported by a payment gateway.

The field used to pass the transactional payment data to the gateway side in the key-value format.

The name of the field.

The value of the field.

Container for payments to be unlinked from the payment schedule item.

The description of the payment schedule item.

ID of the payment gateway of the payment schedule item.

The amount of the payment.

At which hour of the day in the tenant’s timezone this payment will be collected. If the payment runHour and scheduledDate are backdated, the system will collect the payment when the next runHour occurs.

The currency of the payment.