Creates a payment schedule. You can create either recurring payment schedules or custom payment schedules.
Note:
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.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. |
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 should not 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-version | string The minor API version. For a list of available minor versions, see API upgrades |
accountId | string ID of the customer account the payment schedule belongs to. Note:
|
accountNumber | string Account number of the customer account the payment schedule belongs to. Note:
|
amount | number The amount of each payment schedule item in the payment schedule. Note:
|
object Default: "Invoice" Object of the billing document with which the payment schedule is associated. Note:
| |
Array of objects 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 | string Currency of the payment schedule. Note:
|
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:
|
paymentGatewayId | string ID of the payment gateway. Note:
|
paymentMethodId | string ID of the payment method. Note:
|
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:
| |
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 |
period | string The frequency for the payment collection since the Note:
|
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: Note:
|
standalone | boolean Indicate whether the payments created by the payment schedule are standalone payments or not. When setting to Note:
|
startDate | string <date> The date for the first payment collection. Note:
|
totalAmount | number The total amount of that the payment schedule will collect. This field is only available for recurring payment schedules. Note:
|
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. |
Internal Server Error
Request Errors
{- "accountId": "8a90b4488e7d5c0f018e7db3892400b2",
- "amount": 14.99,
- "billingDocument": {
- "id": "8a90b44890c9bb0d0190d8c048a90da6",
- "type": "Invoice"
}, - "items": [
- {
- "scheduledDate": "2024-07-31",
- "amount": 14.99
}
]
}
{- "id": "8a90d61290c9ceb60190d8eac80b1259",
- "paymentScheduleNumber": "PS-00000001",
- "accountId": "8a90b4488e7d5c0f018e7db3892400b2",
- "accountNumber": "A00000370",
- "startDate": "2024-07-31",
- "runHour": 0,
- "period": null,
- "occurrences": 1,
- "status": "Active",
- "totalAmount": 14.99,
- "nextPaymentDate": "2024-07-31",
- "recentPaymentDate": null,
- "totalPaymentsProcessed": 0,
- "totalPaymentsErrored": 0,
- "description": null,
- "isCustom": true,
- "prepayment": false,
- "billingDocument": {
- "id": "8a90b44890c9bb0d0190d8c048a90da6",
- "number": "INV00001823",
- "type": "Invoice"
}, - "billingDocuments": [
- {
- "id": "8a90b44890c9bb0d0190d8c048a90da6",
- "number": "INV00001823",
- "type": "Invoice"
}
], - "createdDate": "2024-07-22 13:29:43",
- "createdById": "2c92c8f95e2d6ebb015e325df48e02da",
- "updatedDate": "2024-07-22 13:29:43",
- "updatedById": "2c92c8f95e2d6ebb015e325df48e02da",
- "cancelledById": null,
- "cancelledOn": null,
- "cancelDate": null,
- "items": [
- {
- "id": "8a90d61290c9ceb60190d8eac80e125a",
- "number": 1,
- "paymentScheduleId": "8a90d61290c9ceb60190d8eac80b1259",
- "paymentScheduleNumber": "PS-00000001",
- "scheduledDate": "2024-07-31",
- "runHour": 0,
- "paymentMethodId": null,
- "paymentGatewayId": null,
- "paymentGatewayNumber": null,
- "amount": 14.99,
- "balance": 14.99,
- "currency": "USD",
- "status": "Pending",
- "errorMessage": null,
- "paymentId": null,
- "billingDocument": {
- "id": "8a90b44890c9bb0d0190d8c048a90da6",
- "number": "INV00001823",
- "type": "Invoice"
}, - "description": null,
- "cancellationReason": null,
- "cancelledById": null,
- "cancelledOn": null,
- "createdDate": "2024-07-22 13:29:43",
- "createdById": "2c92c8f95e2d6ebb015e325df48e02da",
- "updatedDate": "2024-07-22 13:29:43",
- "updatedById": "2c92c8f95e2d6ebb015e325df48e02da"
}
], - "success": true
}