Cancel a payment schedule

Cancels a payment schedule.

Note:

  • All pending payment schedule items will be canceled, effective from cancelDate.
  • 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.
Request
path Parameters
paymentScheduleKey
required
string

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

header Parameters
Accept-Encoding
string

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-Encoding
string

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.

Authorization
string

The value is in the Bearer {token} format where {token} is a valid OAuth token generated by calling Create an OAuth token.

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 (:), semicolon (;), double quote ("), and quote (').

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 do not need to 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 version of the Zuora REST API. See Minor Version for information about REST API version control.

This header affects the availability of the followiing response fields:

  • items > paymentId
Request Body schema: application/json
required
cancelDate
required
string <date>

Specifies when the payment schedule will be canceled.

Responses
200
put/v1/payment-schedules/{paymentScheduleKey}/cancel
Request samples
application/json
{
  • "cancelDate": "2019-08-24"
}
Response samples
application/json
{
  • "accountId": "402880e741112b310149b7343ef81234",
  • "accountNumber": "A-00000001",
  • "cf1__c": "v1",
  • "createdById": "402892f942306295014230a4ab4909bf",
  • "createdDate": "2021-11-01 19:40:00",
  • "description": null,
  • "errorCount": 0,
  • "id": "402880e749b72b310149b7343ef80005",
  • "items": [
    ],
  • "nextProcessDate": "2021-11-01",
  • "occurrences": 2,
  • "paymentScheduleNumber": "PS-00000001",
  • "period": "Monthly",
  • "processedCount": 0,
  • "recentProcessedDate": null,
  • "runHour": 1,
  • "startDate": "2021-11-01",
  • "status": "Canceled",
  • "success": true,
  • "totalAmount": 20,
  • "updatedById": "402892f942306295014230a4ab4909bf",
  • "updatedDate": "2021-11-01 19:40:00"
}