Update an invoice schedule

Updates a pending invoice schedule.\n\nYou can use this API operation
\ to update invoice schedules in the following aspects:\n- Update notes and pending
\ invoice schedule items\n- Update orders associated with invoice schedules\n\

\ the REST API, keep the following restrictions and limitations in mind:\n- You
\ can only update invoice schedule items in Pending status.\n- You can only add
\ orders or specific subscriptions to pending invoice schedules, and remove orders
\ or specific subscriptions from pending invoice schedules.\n- For the invoice
\ schedule items that you want to update, you must include the new values for
\ these items in the request.\n- For the invoice schedule items that you want
\ to keep unchanged, you must include all the existing information about these
\ items in the request. Otherwise, the existing invoice schedule items that you
\ do not mention in the request are deleted.\n- For the orders that you want to
\ keep unchanged for an invoice schedule, you must include all the existing order
\ numbers associated with the invoice schedule in the request. Otherwise, the
\ existing orders that you do not mention in the request are removed.

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 invoice schedule to be updated. 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 (').

Request Body schema: application/json
required
additionalSubscriptionsToBill
Array of strings

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.

invoiceSeparately
boolean

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

nextRunDate
string <date>

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.

notes
string <= 255 characters

Comments on the invoice schedule.

orders
Array of strings

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.

Array of objects (scheduleItems)

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.

Array of objects (specificSubscriptions)

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.
property name*
additional property
any

Custom fields of the Invoice Schedule object. The name of each custom field has the form customField__c. Custom field names are case sensitive. See Manage Custom Fields for more information.

Responses
200
put/v1/invoice-schedules/{scheduleKey}
Request samples
application/json
{
  • "additionalSubscriptionsToBill": [
    ],
  • "invoiceSeparately": false,
  • "nextRunDate": "2022-02-01",
  • "notes": "2022 Billing Schedule - V2",
  • "orders": [
    ],
  • "scheduleItems": [
    ],
  • "specificSubscriptions": [
    ]
}
Response samples
application/json
{
  • "actualAmount": 70200,
  • "additionalSubscriptionsToBill": [
    ],
  • "billedAmount": 0,
  • "currency": "USD",
  • "id": "e2441b3e24eb42859194be7da2403b38",
  • "invoiceSeparately": false,
  • "nextRunDate": "2022-02-24",
  • "notes": "2022 Billing Schedule",
  • "number": "IS-00000004",
  • "orders": [
    ],
  • "scheduleItems": [
    ],
  • "specificSubscriptions": [
    ],
  • "status": "Pending",
  • "success": true,
  • "totalAmount": 70200,
  • "unbilledAmount": 70200
}