Preview the result of payment schedule updates

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:

  • If 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.
  • If only occurrences is updated, the new item will start with the last processed or canceled 'scheduleDate + 1 period'.

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. To manage and access this feature through the self-service interface, see Manage Features in the Knowledge Center.
Request
path Parameters
paymentScheduleKey
required
string

The unique ID or number of a payment schedule. For example, 8a90857b822459cd018224dcb9eb13be, or PS-00000007.

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 fields:

  • paymentOption
  • items > paymentId
Request Body schema: application/json
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:

"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 available versions.

period
string

Indicates the updated period of the pending payment schedule items.

Enum: "Monthly" "Weekly" "BiWeekly"
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: [0,1,2,~,22,23].

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 runHour and scheduledDate are backdated, the system will collect the payment when the next runHour occurs.

property name*
additional property
any

Custom fields of the Payment Schedule 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.

Note: The values will automatically be pushed to payment schedule items level if the same fields exist at the payment schedule item level.

Responses
200
put/v1/payment-schedules/{paymentScheduleKey}/preview
Request samples
application/json
{
  • "amount": 0,
  • "currency": "string",
  • "occurrences": 0,
  • "paymentGatewayId": "string",
  • "paymentMethodId": "string",
  • "paymentOption": [
    ],
  • "period": "Monthly",
  • "periodStartDate": "2019-08-24",
  • "runHour": 0,
  • "property1": null,
  • "property2": null
}
Response samples
application/json
{
  • "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": [
    ],
  • "success": true
}