Update a payment schedule item

Updates a payment schedule item by ID.

Note:

  • The Payment Schedules feature is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at Zuora Global Support.
  • This operation is only available if you have Invoice Settlement enabled.
  • To link a single payment to the payment schedule item, specify the paymentID field in the request body and set zuora-version to equal to or smaller than 336.0; To link or unlink multiple payments with the item, specify the linkPayments and unlinkPayments field in the request body and set zuora-version to equal to or greater than 337.0.
  • The maximum number of payments that are allowed to be linked to a payment schedule item is 10.
  • When unlinking and linking payments with the payment schedule item in one request, Zuora will first unlink the linked payments, and then link new payments to the item.
Request
path Parameters
item-id
required
string

The unique ID of a payment schedule item.

header Parameters
Accept-Encoding
string

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.

Content-Encoding
string

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.

Authorization
string

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

Zuora-Track-Id
string <= 64 characters

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 (').

Zuora-Entity-Ids
string

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.

zuora-version
string

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
  • paymentOption

This header affects the availability of the following response fields:

  • paymentId
  • psiPayments
Request Body schema: application/json
amount
number <decimal>

The amount of the payment.

currency
string

The currency of the payment.

description
string

The description of the payment schedule item.

Array of objects (PaymentID)

Container for payments linked to the payment schedule item.

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

paymentGatewayId
string

ID of the payment gateway of the payment schedule item.

paymentId
string

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.

paymentMethodId
string

ID of the payment method of the payment schedule item.

Array of objects (paymentOption)

Container for the paymentOption items, which describe the transactional level rules for processing payments. Currently, only SEC (Standard Entry Class) code information can be defined in this field for ACH payments on the Citi payment gateway integration.

Here is an example:

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

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

To enable this field, submit a request at Zuora Global Support. This field is only available if zuora-version is set to 337.0 or later.

runHour
integer

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.

scheduledDate
string <date>

The scheduled date when the payment is processed.

Array of objects (PaymentID)

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

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

property name*
additional property
any

Custom fields of the Payment Schedule Item object. The name of each custom field has the form customField__c. Custom field names are case-sensitive. See Manage Custom Fields for more information.

Responses
200
put/v1/payment-schedule-items/{item-id}
Request samples
application/json
{
  • "amount": 0,
  • "currency": "string",
  • "description": "string",
  • "linkPayments": [
    ],
  • "paymentGatewayId": "string",
  • "paymentId": "string",
  • "paymentMethodId": "string",
  • "paymentOption": [
    ],
  • "runHour": 0,
  • "scheduledDate": "2019-08-24",
  • "unlinkPayments": [
    ],
  • "property1": null,
  • "property2": null
}
Response samples
application/json
{
  • "id": "8a90857b822459cd018224dcb9ec13bf",
  • "number": 1,
  • "paymentScheduleId": "8a90857b822459cd018224dcb9eb13be",
  • "paymentScheduleNumber": "PS-00000007",
  • "standalone": false,
  • "scheduledDate": "2022-07-31",
  • "runHour": 23,
  • "paymentMethodId": "8a90a2fd8074995801807817ebed52aa",
  • "paymentGatewayId": "8a90a2fd807499580180781775c452a8",
  • "amount": 30,
  • "currency": "USD",
  • "status": "Pending",
  • "errorMessage": null,
  • "paymentId": null,
  • "billingDocument": {
    },
  • "description": "",
  • "cancellationReason": null,
  • "createdDate": "2022-07-22 00:43:42",
  • "createdById": "8a90e082802185b901802199e15902d1",
  • "updatedDate": "2022-07-22 00:43:42",
  • "updatedById": "8a90e082802185b901802199e15902d1",
  • "success": true
}