Sign in
Payment Schedules

Update a payment schedule

Updates a payment schedule. For custom payment schedules, only the custom fields on the payment schedules can be udpated. Use the Update a payment schedule item operation to update payment schedule items of custom payment schedule.

Note the following rules for the periodStartDate, period, and occurrences:

  • If periodStartDate is specified, all pending payment schedule items will be rescheduled using this new periodStartDate. If period is changed, we recommend passing in periodStartDate. Otherwise, the system would use the original start date if there is no processed or canceled items, or the last processed or canceled 'scheduleDate + 1 period' as the new periodStartDate.
  • If only occurrences is updated, the new item will start with the last processed or canceled 'scheduleDate + 1 period'.

Note:

  • The Payment Schedules feature is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. To manage and access this feature through the self-service interface, see Manage Features in the Knowledge Center.
  • This operation is only available if you have Invoice Settlement enabled.
  • 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.
put/v1/payment-schedules/{paymentScheduleKey}

Path parameters

paymentScheduleKeystring required

The unique ID or number of a payment schedule. For example, 8a90857b822459cd018224dcb9eb13be, or PS-00000007.

Headers

Accept-Encodingstring

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

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

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

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

Comma separated IDs. If you have <a href="https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org" target="_blank">Zuora Multi-Org</a> 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-Versionstring

The minor API version.

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

Request body

amountnumber

Indicates the updated amount of the pending payment schedule items.

currencystring

Indicates the updated currency of the pending payment schedule items.
Note:

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

Description of the payment schedule.

occurrencesinteger

Indicates the updated number of payment schedule items that are created by the payment schedule.

Note:

  • If "updated occurrences > existing occurrences", the following number of pending payment schedule item will be added to the payment schedule: “updated occurrences - existing occurrences”.
  • If "existing occurrences > updated occurrences >= the number of processed/errored/canceled payment schedule items", the following number of pending items will be removed by descending order of the schedule dates: "existing occurrences - updated occurrences".
  • If "updated occurrences < the number of processed/erroed/canceled payment schedule items", a validation error will be returned.
paymentGatewayIdstring

Indicates the updated payment gateway ID of the pending payment schedule items.

paymentMethodIdstring

Indicates the updated payment method ID of the pending payment schedule items.

period'Monthly' | 'Weekly' | 'BiWeekly'

Indicates the updated period of the pending payment schedule items.

periodStartDatestring date

Indicates the updated collection date for the next pending payment schedule item.

runHourinteger

Specifies at which hour of the day in the tenant’s time zone 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. If the payment runHour and scheduledDate are backdated, the system will collect the payment when the next runHour occurs.

Example request

{
  "description": "Details of this payment schedule"
}

Response

OK

accountIdstring

ID of the account that owns the payment schedule.

accountNumberstring

Number of the account that owns the payment schedule.

createdByIdstring

The ID of the user who created this payment schedule.

createdDatestring date

The date and time the payment schedule is created.

cancellationReasonstring nullable

The reason for the cancellation of the payment schedule item.

cancelledByIdstring nullable

The ID of the user who canceled this payment schedule.

cancelledOnstring nullable

The date when the payment schedule was canceled.

cancelDatestring date nullable

Specifies the effective date by when the payment schedule will be canceled.

descriptionstring nullable

The description of the payment schedule.

idstring

ID of the payment schedule.

isCustomboolean

Indicates if the payment schedule is a custom payment schedule.

nextPaymentDatestring date

The date the next payment will be processed.

occurrencesinteger

The number of payment schedule items that are created by this payment schedule.

paymentScheduleNumberstring

Number of the payment schedule.

periodstring nullable

For recurring payment schedule only. The period of payment generation. Available values include: Monthly, Weekly, BiWeekly.

Return null for custom payment schedules.

prepaymentboolean

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

recentPaymentDatestring date nullable

The date the last payment was processed.

runHourinteger

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

At which hour in the day in the tenant’s timezone this payment will be collected.

Return 0 for custom payment schedules.

standaloneboolean

Indicates if the payments that the payment schedule created are standalone payments.

startDatestring 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 is still payment schedule item 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.
successboolean

Returns true if the request was processed successfully.

totalAmountnumber

The total amount that will be collected by the payment schedule.

totalPaymentsErroredinteger

The number of errored payments.

totalPaymentsProcessedinteger

The number of processed payments.

updatedByIdstring

The ID of the user who last updated this payment schedule.

updatedDatestring date

The date and time the payment schedule is last updated.

Changes