Pause an invoice schedule

Pauses an invoice schedule immediately.

After one invoice schedule is paused, it cannot be automatically executed by Zuora Scheduler or by the Execute an invoice schedule API operation.

If you want to run a paused invoice schedule, you can create a bill run with the target date greater than the next run date of the invoice schedule.

Note: This operation is available only if you have the Billing Schedule feature enabled.

Request
path Parameters
scheduleKey
required
string

The unique ID or number of the schedule to be paused. For example, 2c92c8955bd63cc1015bd7c151af02ab or IS-0000001.

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.

Authorization
string

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

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.

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-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 (').

Responses
200
put/v1/invoice-schedules/{scheduleKey}/pause
Request samples
Response samples
application/json
{
  • "actualAmount": 20200,
  • "billedAmount": 50000,
  • "currency": "USD",
  • "id": "e2441b3e24eb42859194be7da2403b38",
  • "nextRunDate": "2022-10-17",
  • "notes": "2022 Billing Schedule",
  • "number": "IS-00000004",
  • "orders": [
    ],
  • "scheduleItems": [
    ],
  • "specificSubscriptions": [
    ],
  • "status": "Paused",
  • "success": true,
  • "totalAmount": 70200,
  • "unbilledAmount": 20200
}