Skip to navigation
PaymentsPayment Schedules

Create a payment schedule

View as Markdown

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.
  • 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.
  • When the Multi-currency and Standalone Payments features are not enabled, you can create and update a payment schedule and payment schedule item in a currency other than the account currency.
  • 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 or a later available version, 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 or a later version.

Authentication

AuthorizationBearer

Use Bearer {{token}} in the Authorization header for authentication.

Headers

Idempotency-KeystringOptional<=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.
Accept-EncodingstringOptional

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

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.

Zuora-Track-IdstringOptional<=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-IdsstringOptional

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

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. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user’s accessible orgs.

Zuora-VersionstringOptional

The minor API version.

For a list of available minor versions, see API upgrades.

Request

This endpoint expects an object.
accountIdstringOptional

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.

accountNumberstringOptional

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.

amountdoubleOptional

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

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.
billingDocumentslist of objectsOptional
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.
currencystringOptional

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.
  • For custom payments, if Multi-currency is enabled, the payment currency can be different from the account currency for custom payment.
  • For recurring payments, if Multi-currency is enabled, the payment currency can be different from the account currency but should be the same as billing currency for a recurring payment.
descriptionstringOptional
Description of the payment schedule. Max length is 255.
itemslist of objectsOptional
Container array for payment schedule items.
occurrencesintegerOptional

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

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

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.
paymentOptionlist of objectsOptional

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.

paymentScheduleNumberstringOptional

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.

periodenumOptional

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.
Allowed values:
prepaymentbooleanOptional

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.

runHourintegerOptional

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

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

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

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.

Response headers

Content-EncodingstringOptional

This header is returned if you specify the Accept-Encoding: gzip request header and the response contains over 1000 bytes of data.

Note that only the following MIME types support gzipped responses:

  • application/json
  • application/xml
  • text/html
  • text/csv
  • text/plain
RateLimit-LimitstringOptional

The request limit quota for the time window closest to exhaustion. See rate limits for more information.

RateLimit-Remainingdouble

The number of requests remaining in the time window closest to quota exhaustion. See rate limits for more information.

RateLimit-Resetdouble

The number of seconds until the quota resets for the time window closest to quota exhaustion. See rate limits for more information.

Zuora-Request-IdstringOptional
The Zuora internal identifier of the API call. You cannot control the value of this header.
Zuora-Track-IdstringOptional
A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.
Concurrency-Limit-TypestringOptional

The type of the concurrency limit, which can be Default, High-volume transactions, or Object Query.

For more information, see Concurrent request limits.

Concurrency-Limit-Limitinteger

The total number of the permitted concurrent requests.

For more information, see Concurrent request limits.

Concurrency-Limit-Remaininginteger

The remaining number of the permitted concurrent requests.

For more information, see Concurrent request limits.

Response

OK
accountIdstringOptional
ID of the account that owns the payment schedule.
accountNumberstringOptional
Number of the account that owns the payment schedule.
billingDocumentobjectOptional
billingDocumentslist of objectsOptional
Container array of the multiple billing documents associated with the payment schedule.
createdByIdstringOptional
ID of the user who created this payment schedule.
createdDatedateOptional
The date and time the payment schedule is created.
descriptionstringOptional
The description of the payment schedule.
idstringOptional
ID of the payment schedule.
isCustombooleanOptional
Indicates if the payment schedule is a custom payment schedule.
itemslist of objectsOptional
Container for payment schedule items.
nextPaymentDatedateOptional
The date the next payment will be processed.
occurrencesintegerOptional
The number of payment schedule items that are created by this payment schedule.
paymentOptionlist of objectsOptional

Container for the paymentOption items, which describe the transactional level rules for processing payments. Currently, only the Gateway Options type is supported.

paymentOption of the payment schedule takes precedence over paymentOption of the payment schedule item.

paymentScheduleNumberstringOptional
Number of the payment schedule.
periodstring or nullOptional

For recurring payment schedule only. The period of payment generation. Available values include: Monthly, Weekly, BiWeekly. Return null for custom payment schedules.

prepaymentbooleanOptional

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

recentPaymentDatedate or nullOptional
The date the last payment was processed.
runHourintegerOptional

[0,1,2,~,22,23]

At which hour in the day in the tenant’s timezone this payment will be collected. If the payment runHour and scheduledDate are backdated, the system will collect the payment when the next runHour occurs. Return 0 for custom payment schedules.

standalonebooleanOptional
Indicates if the payments that the payment schedule created are standalone payments or not.
startDatedateOptional
The date when the first payment of this payment schedule is proccessed.
statusenumOptional

The status of the payment schedule.

  • Active: There are still pament schedule items to process.
  • Canceled: After a payment schedule is canceled by the user, the schedule is marked as Canceled.
  • Completed: After all payment schedule items are processed, the schedule is marked as Completed.
Allowed values:
successbooleanOptional

Returns true if the request was processed successfully.

totalAmountdoubleOptional

The total amount that will be collected by this payment schedule. This field will contain a null value if the standalone value is true.

totalPaymentsErroredintegerOptional
The number of errored payments.
totalPaymentsProcessedintegerOptional
The number of processed payments.
updatedByIdstringOptional
ID of the user who last updated this payment schedule.
updatedDatedateOptional
The date and time the payment schedule is last updated.

Errors

4XX
Client Request Error
500
Internal Server Error