Sign in
Invoice Schedules

Pause an invoice schedule

Pauses an invoice schedule immediately.

A paused invoice schedule and charges inside cannot be automatically executed by Zuora Scheduler or by the <a href="https://developer.zuora.com/api-references/api/operation/POST_ExecuteInvoiceSchedule/" target="_blank">Execute an invoice schedule</a> API operation. In this case, you can do one of the following:

  • Use the <a href="https://developer.zuora.com/v1-api-reference/api/operation/POST_GenerateBillingDocuments/" target="_blank">Generate billing documents by account ID</a> API operation
  • Create a bill run with the target date greater than the next run date of the invoice schedule through UI or API

Note: This operation is available only if you have the <a href="https://docs.zuora.com?resourceId=billing-billing-schedule-overview" target="_blank">Billing Schedule</a> feature enabled.

put/v1/invoice-schedules/{scheduleKey}/pause

Path parameters

scheduleKeystring required

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

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

The ID of the customer account that the invoice schedule belongs to.

actualAmountnumber

The actual amount that needs to be billed during the processing of the invoice schedule.

By default, the actual amount is the same as the total amount. Even if order changes occur like Remove Product or Cancel Subscription, the value of the totalAmount field keeps unchanged. The value of the actualAmount field reflects the actual amount to be billed.

additionalSubscriptionsToBillstring[]

A list of the numbers of the subscriptions that need to be billed together with the invoice schedule.

One invoice schedule can have at most 600 additional subscriptions.

billedAmountnumber

The amount that has been billed during the processing of the invoice schedule.

currencystring

The currency of the billing documents generated during the processing of the invoice schedule. Note: - This field is available only if you have the <a href="https://docs.zuora.com?resourceId=billing-multiple-currencies-overview" target="_blank">Multiple Currencies</a> feature enabled.

  • If you have the Multiple Currencies feature disabled, the corresponding account's default currency is always used.
idstring

The unique ID of the invoice schedule.

invoiceSeparatelyboolean

Whether the invoice items created from the invoice schedule appears on a separate invoice when Zuora generates invoices.

nextRunDatestring date

The run date of the next execution of invoice schedule. By default, the next run date is the same as run date of next pending invoice schedule item. It can be overwritten with a different date other than the default value. When the invoice schedule has completed the execution, the next run date is null.

notesstring

Comments on the invoice schedule.

numberstring

The sequence number of the invoice schedule.

ordersstring[]

A list of the IDs or numbers of the orders associated with the invoice schedule. One invoice schedule can be associated with at most 10 orders.

status'Pending' | 'PartiallyProcessed' | 'Paused' | 'FullyProcessed'

The status of the invoice schedule.

totalAmountnumber

The total amount that needs to be billed during the processing of the invoice schedule.

The value of this field keeps unchanged once invoice schedule items are created.

unbilledAmountnumber

The amount that is waiting to be billed during the processing of the invoice schedule.

organizationLabelstring

Indicates the organization assigned to the Invoice Schedule for multi-org.

Changes