Create a payment schedule

Creates a payment schedule. You can create either recurring payment schedules or custom payment schedules.

Note:

  • This operation is only available if you have Invoice Settlement enabled.
  • You can choose to use payment schedules to process payments associated with billing documents or unapplied payments. If Standalone Payment is enabled, you can also use payment schedules to process standalone payments.
  • This operation is version controlled. If you set zuora-version to 329.0, when creating custom payment schedules associated with billing documents, you need to specify the billing document for each payment schedule item; If zuora-version is set to 330.0, when creating custom payment schedules associated with billing documents, you only need to specify the billing documents at the payment schedule level. The default version number is 329.0. However, we recommend that you specify the version to 330.0. 329.0 will be deprecated soon.
Request
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.

Authorization
string

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

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.

Idempotency-Key
string <= 255 characters

Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types.

With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.

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

  • billingDocument
  • items > billingDocument
Request Body schema: application/json
required
accountId
string

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.

accountNumber
string

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.

amount
number

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

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.
currency
string

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
string

Description of the payment schedule. Max length is 255.

Array of objects (paymentScheduleItemFieldsCustom)

Container array for payment schedule items.

occurrences
integer

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.
paymentGatewayId
string

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.
paymentMethodId
string

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.
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.

paymentScheduleNumber
string

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.

period
string

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.
Enum: "Monthly" "Weekly" "BiWeekly"
prepayment
boolean

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.

runHour
integer

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.
standalone
boolean

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.
startDate
string <date>

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.
totalAmount
number

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.

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
post/v1/payment-schedules
Request samples
application/json
{
  • "accountId": "string",
  • "accountNumber": "string",
  • "amount": 0,
  • "billingDocument": {
    },
  • "currency": "string",
  • "description": "string",
  • "items": [
    ],
  • "occurrences": 0,
  • "paymentGatewayId": "string",
  • "paymentMethodId": "string",
  • "paymentOption": [
    ],
  • "paymentScheduleNumber": "string",
  • "period": "Monthly",
  • "prepayment": true,
  • "runHour": 0,
  • "standalone": true,
  • "startDate": "2019-08-24",
  • "totalAmount": 0,
  • "property1": null,
  • "property2": null
}
Response samples
application/json
{
  • "accountId": "402880e741112b310149b7343ef81234",
  • "accountNumber": "A-00000001",
  • "cf1__c": "v1",
  • "createdById": "402892f942306295014230a4ab4909bf",
  • "createdDate": "2021-11-01 19:40:00",
  • "description": null,
  • "errorCount": 0,
  • "id": "402880e749b72b310149b7343ef80005",
  • "items": [
    ],
  • "nextProcessDate": "2021-11-01",
  • "occurrences": 2,
  • "paymentScheduleNumber": "PS-00000001",
  • "period": "Monthly",
  • "processedCount": 0,
  • "recentProcessedDate": null,
  • "runHour": 1,
  • "startDate": "2021-11-01",
  • "status": "Active",
  • "success": true,
  • "totalAmount": 20,
  • "updatedById": "402892f942306295014230a4ab4909bf",
  • "updatedDate": "2021-11-01 19:40:00",
  • "“isCustom”": true,
  • "“standalone”": true
}