Sign in
Payment Schedules

Cancel a payment schedule item

Cancels a payment schedule item by ID.

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.
put/v1/payment-schedule-items/{item-id}/cancel

Path parameters

item-idstring required

The unique ID of a payment schedule item.

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.

Response

OK

accountIdstring

ID of the customer account that owns the payment schedule item, for example 402880e741112b310149b7343ef81234.

amountnumber

The amount of the payment schedule item.

balancenumber

The remaining balance of payment schedule item.

cancellationReasonstring nullable

The reason for the cancellation of payment schedule item.

createdByIdstring

The ID of the user who created the payment schedule item.

createdDatestring date

The date and time when the payment schedule item was created.

currencystring

The currency of the payment.

descriptionstring nullable

The description of the payment schedule item.

errorMessagestring nullable

The error message indicating if the error is related to the configuration or the payment collection.

idstring

ID of the payment schedule item. For example, 412880e749b72b310149b7343ef81346.

numberstring

Number of the payment schedule item.

paymentGatewayIdstring nullable

ID of the payment gateway of the payment schedule item.

paymentMethodIdstring

ID of the payment method of the payment schedule item.

paymentScheduleIdstring

ID of the payment schedule that contains the payment schedule item, for example, ID402880e749b72b310149b7343ef80005,

paymentScheduleNumberstring

Number of the payment schedule that contains the payment schedule item, for example, ID402880e749b72b310149b7343ef80005,

runHourinteger

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

scheduledDatestring date

The scheduled date when the payment is processed.

standaloneboolean

Indicates if the payment created by the payment schedule item is a standalone payment.

status'Pending' | 'Processed' | 'Error' | 'Canceled'

ID of the payment method of the payment schedule item.

  • Pending: 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.
successboolean

Returns true if the request was processed successfully.

updatedByIdstring

The ID of the user who updated the payment schedule item.

updatedDatestring date

The date and time when the payment schedule item was last updated.

Changes