Updates a payment schedule item by ID.
Note:
linkPayments
and unlinkPayments
field in the request body. 10
.Accept-Encoding | string Include the If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a |
Content-Encoding | string Include the |
Authorization | string The value is in the |
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 ( |
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 should not set this header. |
Zuora-Org-Ids | string 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. |
zuora-version | string The minor API version. For a list of available minor versions, see API upgrades |
amount | number <decimal> The amount of the payment. |
currency | string The currency of the payment. |
description | string The description of the payment schedule item. |
linkPayments | Array of strings Container for payments linked to the payment schedule item. |
paymentGatewayId | string or null ID of the payment gateway of the payment schedule item. |
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 the Gateway Options type is supported. Here is an example:
| |
runHour | integer At which hour of the day in the tenant’s timezone this payment will be collected. If the payment |
scheduledDate | string <date> The scheduled date when the payment is processed. |
unlinkPayments | Array of strings Container for payments to be unlinked from the payment schedule item. |
property name* additional property | any Custom fields of the Payment Schedule Item object. The name of each custom field has the form |
Internal Server Error
Request Errors
{- "paymentMethodId": "8a90b44890c9bb0d0190d960b9191eea"
}
{- "id": "8a90d61290c9ceb60190d8eac80e125a",
- "number": 1,
- "paymentScheduleId": "8a90d61290c9ceb60190d8eac80b1259",
- "paymentScheduleNumber": "PS-00000001",
- "scheduledDate": "2024-07-31",
- "runHour": 0,
- "paymentMethodId": "8a90b44890c9bb0d0190d960b9191eea",
- "paymentGatewayId": null,
- "paymentGatewayNumber": null,
- "amount": 14.99,
- "balance": 14.99,
- "currency": "USD",
- "status": "Pending",
- "errorMessage": null,
- "paymentId": null,
- "billingDocument": {
- "id": "8a90b44890c9bb0d0190d8c048a90da6",
- "number": "INV00001823",
- "type": "Invoice"
}, - "description": null,
- "cancellationReason": null,
- "cancelledById": null,
- "cancelledOn": null,
- "createdDate": "2024-07-22 13:29:43",
- "createdById": "2c92c8f95e2d6ebb015e325df48e02da",
- "updatedDate": "2024-07-22 15:40:21",
- "updatedById": "2c92c8f95e2d6ebb015e325df48e02da",
- "success": true
}