Preview the result of a payment schedule update. This operation only provides a preview. No changes will be made to the database. For custom payment schedules, only the custom fields on the payment schedules can be udpated. Use the Update a payment schedule item operation to update payment schedule items of custom payment schedule.
Note the following rules for the periodStartDate
, period
, and occurrences
:
periodStartDate
is specified, all pending payment schedule items will be rescheduled using this new periodStartDate
. If period
is changed, we recommend passing in periodStartDate
. Otherwise, the system would use the original start date if there is no processed or canceled items, or the last processed or canceled 'scheduleDate
+ 1 period
' as the new periodStartDate
.occurrences
is updated, the new item will start with the last processed or canceled 'scheduleDate
+ 1 period
'.Note:
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 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 fields:
|
amount | number Indicates the updated amount of the pending payment schedule items. |
currency | string Indicates the updated currency of the pending payment schedule items. |
occurrences | integer Indicates the updated number of payment schedule items that are created by the payment schedule. |
paymentGatewayId | string Indicates the updated payment gateway ID of the pending payment schedule items. |
paymentMethodId | string Indicates the updated payment method ID of the pending payment schedule items. |
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:
To enable this field, submit a request at Zuora Global Support. This field is only available if | |
period | string Indicates the updated period of the pending payment schedule items. |
periodStartDate | string <date> Indicates the updated collection date for the next pending payment schedule item. |
runHour | integer <date> Specifies at which hour of the day in the tenant’s time zone this payment will be collected. Available values: If the time difference between your tenant’s timezone and the timezone where Zuora servers are is not in full hours, for example, 2.5 hours, the payment schedule items will be triggered half hour later than your scheduled time. If the payment |
property name* additional property | any Custom fields of the Payment Schedule object. The name of each custom field has the form Note: The values will automatically be pushed to payment schedule items level if the same fields exist at the payment schedule item level. |
{- "amount": 0,
- "currency": "string",
- "occurrences": 0,
- "paymentGatewayId": "string",
- "paymentMethodId": "string",
- "paymentOption": [
- {
- "detail": {
- "key": "string",
- "value": "string"
}, - "type": "string"
}
], - "period": "Monthly",
- "periodStartDate": "2019-08-24",
- "runHour": 0,
- "property1": null,
- "property2": null
}
{- "id": "8a90e08281e10bb00181e749f4db01b8",
- "paymentScheduleNumber": "PS-00000002",
- "standalone": true,
- "accountId": "8a90a2fd8074995801807816dbac52a4",
- "accountNumber": "A00000002",
- "startDate": "2022-07-10",
- "runHour": 23,
- "period": "Monthly",
- "occurrences": 5,
- "status": "Active",
- "nextPaymentDate": "2022-11-01",
- "recentPaymentDate": null,
- "totalPaymentsProcessed": 0,
- "totalPaymentsErrored": 0,
- "description": "test xiaokai",
- "isCustom": false,
- "billingDocument": null,
- "createdDate": "2022-07-10 01:46:33",
- "createdById": "8a90e082802185b901802199e15902d1",
- "updatedDate": "2022-07-28 06:12:39",
- "updatedById": "8a90e082802185b901802199e15902d1",
- "items": [
- {
- "id": "8a90e08281e10bb00181e749f4dd01b9",
- "number": 1,
- "paymentScheduleId": "8a90e08281e10bb00181e749f4db01b8",
- "paymentScheduleNumber": "PS-00000002",
- "standalone": true,
- "scheduledDate": "2022-07-10",
- "runHour": 12,
- "paymentMethodId": "8a90a2fd8074995801807817ebed52aa",
- "paymentGatewayId": "8a90a2fd807499580180781775c452a8",
- "amount": 100,
- "currency": "USD",
- "status": "Canceled",
- "errorMessage": null,
- "paymentId": null,
- "billingDocument": null,
- "description": "test xiaokai",
- "createdDate": "2022-07-10 01:46:33",
- "createdById": "8a90e082802185b901802199e15902d1",
- "updatedDate": "2022-07-28 06:12:39",
- "updatedById": "8a90e082802185b901802199e15902d1"
}, - {
- "id": "8a90e08281e10bb00181e749f4e501ba",
- "number": 2,
- "paymentScheduleId": "8a90e08281e10bb00181e749f4db01b8",
- "paymentScheduleNumber": "PS-00000002",
- "standalone": true,
- "scheduledDate": "2022-08-10",
- "runHour": 12,
- "paymentMethodId": "8a90a2fd8074995801807817ebed52aa",
- "paymentGatewayId": "8a90a2fd807499580180781775c452a8",
- "amount": 100,
- "currency": "USD",
- "status": "Canceled",
- "errorMessage": null,
- "paymentId": null,
- "billingDocument": null,
- "description": "test xiaokai",
- "createdDate": "2022-07-10 01:46:33",
- "createdById": "8a90e082802185b901802199e15902d1",
- "updatedDate": "2022-07-28 06:12:39",
- "updatedById": "8a90e082802185b901802199e15902d1"
}, - {
- "id": "8a90e08281e10bb00181e749f4e601bb",
- "number": 3,
- "paymentScheduleId": "8a90e08281e10bb00181e749f4db01b8",
- "paymentScheduleNumber": "PS-00000002",
- "standalone": true,
- "scheduledDate": "2022-11-01",
- "runHour": 23,
- "paymentMethodId": "8a90a2fd8074995801807817ebed52aa",
- "paymentGatewayId": "8a90a2fd807499580180781775c452a8",
- "amount": 10,
- "currency": "USD",
- "status": "Pending",
- "errorMessage": null,
- "paymentId": null,
- "billingDocument": null,
- "description": "test xiaokai",
- "createdDate": "2022-07-10 01:46:33",
- "createdById": "8a90e082802185b901802199e15902d1",
- "updatedDate": "2022-07-28 06:12:39",
- "updatedById": "8a90e082802185b901802199e15902d1"
}, - {
- "id": "8a908de6822b2e1501823352ac745b53",
- "number": 4,
- "paymentScheduleId": "8a90e08281e10bb00181e749f4db01b8",
- "paymentScheduleNumber": "PS-00000002",
- "standalone": true,
- "scheduledDate": "2022-12-01",
- "runHour": 23,
- "paymentMethodId": "8a90a2fd8074995801807817ebed52aa",
- "paymentGatewayId": "8a90a2fd807499580180781775c452a8",
- "amount": 10,
- "currency": "USD",
- "status": "Pending",
- "errorMessage": null,
- "paymentId": null,
- "billingDocument": null,
- "description": "test xiaokai",
- "createdDate": "2022-07-24 20:07:12",
- "createdById": "8a90e082802185b901802199e15902d1",
- "updatedDate": "2022-07-28 06:12:39",
- "updatedById": "8a90e082802185b901802199e15902d1"
}, - {
- "id": "8a90e082824456ae018244f00e0317eb",
- "number": 5,
- "paymentScheduleId": "8a90e08281e10bb00181e749f4db01b8",
- "paymentScheduleNumber": "PS-00000002",
- "standalone": true,
- "scheduledDate": "2023-01-01",
- "runHour": 23,
- "paymentMethodId": "8a90a2fd8074995801807817ebed52aa",
- "paymentGatewayId": "8a90a2fd807499580180781775c452a8",
- "amount": 10,
- "currency": "USD",
- "status": "Pending",
- "errorMessage": null,
- "paymentId": null,
- "billingDocument": null,
- "description": "test xiaokai",
- "createdDate": "2022-07-28 06:12:39",
- "createdById": "8a90e082802185b901802199e15902d1",
- "updatedDate": "2022-07-28 06:12:39",
- "updatedById": "8a90e082802185b901802199e15902d1"
}
], - "success": true
}