PUT /v1/invoice-schedules/{scheduleKey}

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

Default value: "application/json"

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.

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

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

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.

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.

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.

A list of the numbers of specific subscriptions associated with the invoice schedule.

• If the subscriptions specified in this field belong to the orders specified in the orders field, only the specific subscriptions instead of the orders are associated with the invoice schedule.
• If only the orders field is specified, all the subscriptions from the order are associated with the invoice schedule.

The specific subscriptions specified in this field override all the existing specific subscriptions associated with the invoice schedule.

Example:

{
  "orders": [
    "O-00000001", "O-00000002"
  ],
  "specificSubscriptions": [
    {
      "orderKey": "O-00000001",
      "subscriptionKey": "S-00000001"
    }
  ]
}

• For the order with number O-00000001, only subscription S-00000001 contained in the order is associated with the invoice schedule.
• For the order with number O-00000002, all subscriptions contained in the order are associated with the invoice schedule.

A list of charges in the subscription that are chosen to be included in the invoice schedule.

The unique ID or number of the order associated with the invoice schedule.

The unique number of the subscription contained in the order associated with the invoice schedule.

The run date of the next execution of the invoice schedule.

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

Comments on the invoice schedule.

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

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.

The orders specified in this field override all the existing orders associated with the invoice schedule.

Container for invoice schedule items. The maximum number of schedule items is 50.

The invoice schedule items specified in this field override all the existing invoice schedule items.

The unique ID of the invoice schedule item to be updated.

If this field is not provided, a new invoice schedule item is added to the invoice schedule.

The name of the invoice schedule item.

The date in the tenant's time zone used by the invoice schedule to determine which fixed-period regular charges to be billed together with the invoice schedule item.

The regular charges must come from the subscriptions specified in the additionalSubscriptionsToBill field.

The date in the tenant’s time zone when the invoice schedule item is planned to be processed to generate an invoice.

The amount of the invoice to be generated during the processing of the invoice schedule item.

You can only specify either the amount field or percentage field in one request.

• If you choose to specify the amount field in the request, null is returned as the value of the percentage field in the corresponding response.
• If you choose to specify the percentage field in the request, the value of the amount field returned in the corresponding response is calculated based on the percentage of the total amount.

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.