ID of the customer account the payment schedule belongs to.

Note: accountId and accountNumber cannot both be null. When both fields are specified, the two values must match each other.

Account number of the customer account the payment schedule belongs to.

Note: accountId and accountNumber cannot both be null. When both fields are specified, the two values must match each other.

The amount of each payment schedule item in the payment schedule.

Note:

• This field is required when items is not specified.
• This field will be ignored when items is specified.
• When creating recurring payment schedules, there are 2 options to specify amounts:
  • Specify totalAmount and occurrences, amount will be calculated.
  • Specify amount and occurrences, totalAmount will be calculated. You must specify either totalAmount or amount. Specifying both fields at the same time is not allowed.

Object of the billing document with which the payment schedule is associated.

Note:

• This field is optional. If you have the Standalone Payment feature enabled, you can leave this field blank and set standalone to true to create standalone payments. You can also choose to create unapplied payments by leaving this object blank and setting standalone to false.
• If Standalone Payment is not enabled, leaving this object unspecified will create unapplied payments.
• This field is available only if you are on the latest Zuora API version, or you set the zuora-version request header to 330.0 or a later available version.

Container array of the multiple billing documents associated with the payment schedule.

If multiple billing documents are associated to a payment schedule, when collecting the payment schedule item, the payment belongs to the payment schedule item will be applied to billing documents based on the due date of the billing document, in the ascending order.

Currency of the payment schedule.

Note:

• This field is optional. The default value is the account's default currency.
• This field will be ignored when items is specified.

Description of the payment schedule. Max length is 255.

Container array for payment schedule items.

The number of payment schedule item to be created. Maximum value is 1000.

Note:

• This field is required when items is not specified.
• This field will be ignored when items is specified.

ID of the payment gateway.

Note:

• This field is optional. The default value is the account's default payment gateway ID. If no payment gateway ID is found on the cusotmer account level, the default value will be the tenant's default payment gateway ID.
• This field will be ignored when items is specified.

ID of the payment method.

Note:

• This field is optional. The default value is the account's default payment method ID.
• This field will be ignored when items is specified.

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.

You can use this field to specify the number of the payment schedule. Only characters from the following sets are allowed: A-Z, a-z, 0-9, and -. Payment numbers must start with a letter. In addition,- can only be used at most once and cannot be placed at the beginning or the end of the payment numbers.

The frequency for the payment collection since the startDate.

Note:

• Thie field is required when items is not specified.
• This field will be ignored when items is specified.
• If startDate is 30 or 31 and period is Monthly, when in February, payment schedule will use the last day of February for payment collection.

Indicates whether the payments created by the payment schedule will be used as reserved payments. This field will only be available if the prepaid cash drawdown permission is enabled. See Prepaid Cash with Drawdown for more information.

Specifies at which hour in the day in the tenant’s time zone when this payment will be collected. Available values: [0,1,2,~,22,23].

Note:

• 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.
• This field is optional. The default value is 0.
• This field will be ignored when items is specified.

Indicate whether the payments created by the payment schedule are standalone payments or not. When setting to true, standalone payments will be created. When setting to false, you can either specify a billing document, or not specifying any billing documents. In the later case, unapplied payments will be created. If set to null, standalone payment will be created.

Note:

• This field is only available if the Standalone Payment is enabled. Do not include this field if Standalone Payment is not enabled.
• If Standalone Payment is enabled, default value is true.

The date for the first payment collection.

Note:

• This field is required when items is not specified.
• This field will be ignored when items is specified.

The total amount of that the payment schedule will collect. This field is only available for recurring payment schedules.

Note:

• When creating recurring payment schedules, there are 2 options to specify amounts:

  • Specify totalAmount and occurrences, amount will be calculated.
  • Specify amount and occurrences, totalAmount will be calculated.

  You must specify either totalAmount or amount. Specifying both fields at the same time is not allowed.

• If the Standalone Payments feature is enabled and standalone is set to true for the payment schedule, totalAmount will be ignored.