--- title: "Create a payment schedule" method: POST path: "/v1/payment-schedules" tags: ["Payment Schedules"] --- # Create a payment schedule `POST /v1/payment-schedules` 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](https://docs.zuora.com?resourceId=billing-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. ## Headers - `Idempotency-Key` string - `Accept-Encoding` string - `Content-Encoding` string - `Zuora-Track-Id` string - `Zuora-Entity-Ids` string - `Zuora-Org-Ids` string - `Zuora-Version` string ## Request body - POSTPaymentScheduleRequest — Container for custom fields of a Payment Schedule object. - `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. - `billingDocument` 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. - 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](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version). - `id` string — ID of the billing document. **Note:** If a billing document is specified, either `id` or `number` of the billing document must be specified. You cannot specify both of them or skip both. - `number` string — Number of the billing document. **Note:** If a billing document is specified, either `id` or `number` of the billing document must be specified. You cannot specify both of them or skip both. - `type` 'Invoice' | 'DebitMemo', required — The type of the billing document. - `billingDocuments` object[] — 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. - `id` string — ID of the billing document. **Note:** If a billing document is specified, either `id` or `number` of the billing document must be specified. You cannot specify both of them or skip both. - `number` string — Number of the billing document. If the billing document is a debit memo, it contains the debit memo number. If the billing document is an invoice, it contains the invoice number. **Note:** If a billing document is specified, either `id` or `number` of the billing document must be specified. You cannot specify both of them or skip both. - `type` 'Invoice' | 'DebitMemo', required — Denotes if the billing document is of the type invoice or debit memo. - `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. - 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. - `description` string — Description of the payment schedule. Max length is 255. - `items` object[] — Container array for payment schedule items. - `amount` number — The amount that needs to be collected by this payment schedule item. - `billingDocument` object — Object for the billing document with which the payment schedule item is associated. **Note:** You must specify the same billing document for all the payment schedule items in one payment schedule. - `id` string — The ID of the billing document. **Note:** If a billing document is specified, one of `id` or `number` must be specified. You cannot specify both of them or or skip both. - `number` string — The number of the billing document. **Note:** If a billing document is specified, one of `id` or `number` must be specified. You cannot specify both of them or skip both. - `type` 'Invoice' | 'DebitMemo', required — The type of the billing document. The default value is `Invoice`. - `currency` string — The currency of the payment. **Note**: - This field is optional. If not specified, the default value is the currency set for the account. - 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. - `description` string — Description of the payment schedule item. - `paymentGatewayId` string — The ID of the payment gateway. **Note**: - This field is optional. If not specified, the default value is the payment gateway id set for the account. - `paymentMethodId` string — The ID of the payment method. **Note**: - This field is optional. If not specified, the default value is the payment method id set for the account. - `paymentOption` PaymentSchedulePaymentOptionFields[] — 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](https://support.zuora.com/). This field is only available if `Zuora-Version` is set to `337.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version). - `detail` object — The field used to pass the transactional payment data to the gateway side in the key-value format. - `key` string — The name of the field. - `value` string — The value of the field. - `type` string — The type of the payment option. Currently, only `GatewayOptions` is supported for specifying Gateway Options fields supported by a payment gateway. - `runHour` string — At which hour in the day in the tenant’s timezone 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. The default value is `0`. If the payment `runHour` and `scheduledDate` are backdated, the system will collect the payment when the next runHour occurs. - `scheduledDate` string, date — The date to collect the payment. - `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. - `paymentOption` PaymentSchedulePaymentOptionFields[] — 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. - `detail` object — The field used to pass the transactional payment data to the gateway side in the key-value format. - `key` string — The name of the field. - `value` string — The value of the field. - `type` string — The type of the payment option. Currently, only `GatewayOptions` is supported for specifying Gateway Options fields supported by a payment gateway. - `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` 'Monthly' | 'Weekly' | 'BiWeekly' — 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. - `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](https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview) 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. ## Response `200` OK - POSTPaymentScheduleResponse — Container for custom fields of a Payment Schedule object. - `accountId` string — ID of the account that owns the payment schedule. - `accountNumber` string — Number of the account that owns the payment schedule. - `billingDocument` object - `id` string — ID of the billing document. for example, `2c9890306fb2121e016fb21a6b550041`. - `number` string — Number of the billing docuemnt, for example, `INV00002345`. - `type` string — Indicates whether the associated billing document is a debit memo or a invoice. - `billingDocuments` object[] — Container array of the multiple billing documents associated with the payment schedule. - `id` string — ID of the billing document. - `number` string — Number of the billing document. If the billing document is a debit memo, it contains the debit memo number. If the billing document is an invoice, it contains the invoice number. - `type` 'Invoice' | 'DebitMemo' — Denotes if the billing document is of the type invoice or debit memo. - `createdById` string — ID of the user who created this payment schedule. - `createdDate` string, date — The date and time the payment schedule is created. - `description` string, nullable — The description of the payment schedule. - `id` string — ID of the payment schedule. - `isCustom` boolean — Indicates if the payment schedule is a custom payment schedule. - `items` PaymentScheduleItemCommonResponse[] — Container for payment schedule items. - `accountId` string — ID of the customer account that owns the payment schedule item, for example `402880e741112b310149b7343ef81234`. - `amount` number, nullable — The total amount of the payment schedule. - `balance` number — The remaining balance of payment schedule item. - `billingDocument` object, nullable - `id` string — ID of the billing document. for example, `2c9890306fb2121e016fb21a6b550041`. - `number` string — Number of the billing docuemnt, for example, `INV00002345`. - `type` string — Indicates whether the associated billing document is a debit memo or a invoice. - `createdById` string, nullable — The ID of the user who created the payment schedule item. - `createdDate` string, date, nullable — The date and time when the payment schedule item was created. - `currency` string, nullable — The currency of the payment. - `description` string, nullable — The description of the payment schedule item. - `errorMessage` string, nullable — The error message indicating if the error is related to configuration or payment collection. - `id` string — ID of the payment schedule item. For example, `412880e749b72b310149b7343ef81346`. - `number` string — Number of the payment schedule item. - `paymentGatewayId` string, nullable — ID of the payment gateway of the payment schedule item. - `paymentMethodId` string, nullable — ID of the payment method of the payment schedule item. - `paymentOption` PaymentSchedulePaymentOptionFields[] — 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. - `detail` object — The field used to pass the transactional payment data to the gateway side in the key-value format. - `key` string — The name of the field. - `value` string — The value of the field. - `type` string — The type of the payment option. Currently, only `GatewayOptions` is supported for specifying Gateway Options fields supported by a payment gateway. - `paymentScheduleId` string — ID of the payment schedule that contains the payment schedule item, for example, `ID402880e749b72b310149b7343ef80005`. - `paymentScheduleNumber` string — Number of the payment schedule that contains the payment schedule item, for example, `ID402880e749b72b310149b7343ef80005`. - `psiPayments` LinkedPaymentID[] — Container for payments linked to the payment schedule item. - `paymentId` string — ID of the payment. - `runHour` integer, nullable — At which hour in the day in the tenant’s timezone this payment will be collected. - `scheduledDate` string, date, nullable — The scheduled date when the payment is processed. - `standalone` boolean — Indicates if the payment created by the payment schedule item is a standalone payment or not. - `status` 'Pending' | 'Processed' | 'Error' | 'Canceled', nullable — ID of the payment method of the payment schedule item. - `Pending`: Payment schedule item is waiting for processing. - `Processed`: The payment has been collected. - `Error`: Failed to collect the payment. - `Canceled`: After a pending payment schedule item is canceled by the user, the item is marked as `Canceled`. - `updatedById` string, nullable — The ID of the user who updated the payment schedule item. - `updatedDate` string, date, nullable — The date and time when the payment schedule item was last updated. - `nextPaymentDate` string, date — The date the next payment will be processed. - `occurrences` integer — The number of payment schedule items that are created by this payment schedule. - `paymentOption` PaymentSchedulePaymentOptionFields[] — 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. - `detail` object — The field used to pass the transactional payment data to the gateway side in the key-value format. - `key` string — The name of the field. - `value` string — The value of the field. - `type` string — The type of the payment option. Currently, only `GatewayOptions` is supported for specifying Gateway Options fields supported by a payment gateway. - `paymentScheduleNumber` string — Number of the payment schedule. - `period` string, nullable — For recurring payment schedule only. The period of payment generation. Available values include: `Monthly`, `Weekly`, `BiWeekly`. Return `null` for custom payment schedules. - `prepayment` boolean — 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](https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview) for more information. - `recentPaymentDate` string, date, nullable — The date the last payment was processed. - `runHour` integer — [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. - `standalone` boolean — Indicates if the payments that the payment schedule created are standalone payments or not. - `startDate` string, date — The date when the first payment of this payment schedule is proccessed. - `status` 'Active' | 'Canceled' | 'Completed' — 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`. - `success` boolean — Returns `true` if the request was processed successfully. - `totalAmount` number — The total amount that will be collected by this payment schedule. This field will contain a null value if the `standalone` value is `true`. - `totalPaymentsErrored` integer — The number of errored payments. - `totalPaymentsProcessed` integer — The number of processed payments. - `updatedById` string — ID of the user who last updated this payment schedule. - `updatedDate` string, date — The date and time the payment schedule is last updated. ## Other responses - `500` — Internal Server Error - `4XX` — Request Errors --- [API](https://skmtc.dev/zuora/apis/api-reference.md) · [All operations](https://skmtc.dev/zuora/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/zuora/api-reference/revisions/d11e237f3e54/schema)