Update an invoice schedule

PUT

/v1/invoice-schedules/:scheduleKey

PUT

/v1/invoice-schedules/:scheduleKey

from zuora import ZuoraClient, UpdateScheduleItems, InvoiceScheduleSpecificSubscriptions
import datetime
client = ZuoraClient(
    token="YOUR_TOKEN_HERE",
)
client.invoice_schedules.put_update_invoice_schedule(
    schedule_key="scheduleKey",
    additional_subscriptions_to_bill=[
        "S-00000001",
        "S-00000002"
    ],
    invoice_separately=False,
    next_run_date=datetime.date.fromisoformat("2022-02-01"),
    notes="2022 Billing Schedule - V2",
    orders=[
        "O-00000007",
        "O-00000008"
    ],
    schedule_items=[
        UpdateScheduleItems(
            amount="54000",
            id="8a8881aa82118bec018211daf9f01680",
            run_date=datetime.date.fromisoformat("2022-02-24"),
            target_date_for_additional_subscriptions=datetime.date.fromisoformat("2022-02-24"),
        ),
        UpdateScheduleItems(
            amount="10000",
            id="8a8881aa82118bec018211daf9f11681",
            run_date=datetime.date.fromisoformat("2022-10-17"),
            target_date_for_additional_subscriptions=datetime.date.fromisoformat("2022-10-17"),
        ),
        UpdateScheduleItems(
            amount="6200",
            id="8a8881aa82118bec018211daf9f11682",
            run_date=datetime.date.fromisoformat("2022-11-14"),
            target_date_for_additional_subscriptions=datetime.date.fromisoformat("2022-11-14"),
        )
    ],
    specific_subscriptions=[
        InvoiceScheduleSpecificSubscriptions(
            order_key="O-00000008",
            subscription_key="S-00000008",
        )
    ],
)

{
  "actualAmount": 70200,
  "additionalSubscriptionsToBill": [
    "S-00000001",
    "S-00000002"
  ],
  "billedAmount": 0,
  "currency": "USD",
  "id": "e2441b3e24eb42859194be7da2403b38",
  "invoiceSeparately": false,
  "nextRunDate": "2022-02-24",
  "notes": "2022 Billing Schedule",
  "number": "IS-00000004",
  "orders": [
    "O-00000007",
    "O-00000008"
  ],
  "scheduleItems": [
    {
      "actualAmount": "54000",
      "amount": "54000",
      "id": "8a8881aa82118bec018211daf9f01680",
      "percentage": null,
      "runDate": "2022-02-24",
      "status": "Pending",
      "targetDateForAdditionalSubscriptions": "2022-02-24"
    },
    {
      "actualAmount": "10000",
      "amount": "10000",
      "id": "8a8881aa82118bec018211daf9f11681",
      "percentage": null,
      "runDate": "2022-10-17",
      "status": "Pending",
      "targetDateForAdditionalSubscriptions": "2022-10-17"
    },
    {
      "actualAmount": "6200",
      "amount": "6200",
      "id": "8a8881aa82118bec018211daf9f11682",
      "percentage": null,
      "runDate": "2022-11-14",
      "status": "Pending",
      "targetDateForAdditionalSubscriptions": "2022-11-14"
    }
  ],
  "specificSubscriptions": [
    {
      "orderKey": "O-00000008",
      "subscriptionKey": "S-00000008"
    }
  ],
  "status": "Pending",
  "totalAmount": 70200,
  "unbilledAmount": 70200,
  "success": true
}

Updates a pending invoice schedule. You can use this API operation to update invoice schedules in the following aspects:

Update notes and pending invoice schedule items
Update orders associated with invoice schedules
Remove or add invoice schedule items For more samples, see Edit invoice schedules

Restrictions and limitations

When updating invoice schedules through the REST API, keep the following restrictions and limitations in mind:

You can only update invoice schedule items in Pending status.
You can only add orders or specific subscriptions to pending invoice schedules, and remove orders or specific subscriptions from pending invoice schedules.
For the invoice schedule items that you want to update, you must include the new values for these items in the request.
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 include in the request are deleted.
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 include in the request are removed.

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

Authentication

AuthorizationBearer

Use Bearer {{token}} in the Authorization header for authentication.

Path parameters

scheduleKeystringRequired

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

Headers

Content-EncodingstringOptional

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-Org-IdsstringOptional

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. 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.

Request

This endpoint expects an object.

additionalSubscriptionsToBilllist of stringsOptional

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.

invoiceSeparatelybooleanOptional

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

nextRunDatedateOptional

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.

notesstringOptional<=255 characters

Comments on the invoice schedule.

orderslist of stringsOptional

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.

scheduleItemslist of objectsOptional

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.

specificSubscriptionslist of objectsOptional

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.

Response headers

Content-EncodingstringOptional

This header is returned if you specify the Accept-Encoding: gzip request header and the response contains over 1000 bytes of data.

Note that only the following MIME types support gzipped responses:

application/json
application/xml
text/html
text/csv
text/plain

RateLimit-LimitstringOptional

The request limit quota for the time window closest to exhaustion. See rate limits for more information.

RateLimit-Remainingdouble

The number of requests remaining in the time window closest to quota exhaustion. See rate limits for more information.

RateLimit-Resetdouble

The number of seconds until the quota resets for the time window closest to quota exhaustion. See rate limits for more information.

Zuora-Request-IdstringOptional

The Zuora internal identifier of the API call. You cannot control the value of this header.

Zuora-Track-IdstringOptional

A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.

Concurrency-Limit-TypestringOptional

The type of the concurrency limit, which can be Default, High-volume transactions, or Object Query.

For more information, see Concurrent request limits.

Concurrency-Limit-Limitinteger

The total number of the permitted concurrent requests.

For more information, see Concurrent request limits.

Concurrency-Limit-Remaininginteger

The remaining number of the permitted concurrent requests.

For more information, see Concurrent request limits.

Response

accountIdstringOptional

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

actualAmountdoubleOptional

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.

additionalSubscriptionsToBilllist of stringsOptional

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.

billedAmountdoubleOptional

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

currencystringOptional

The currency of the billing documents generated during the processing of the invoice schedule. Note: - This field is available only if you have the Multiple Currencies feature enabled.

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

idstringOptional

The unique ID of the invoice schedule.

invoiceSeparatelybooleanOptional

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

nextRunDatedateOptional

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.

notesstringOptional<=255 characters

Comments on the invoice schedule.

numberstringOptional

The sequence number of the invoice schedule.

orderslist of stringsOptional

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.

scheduleItemslist of objectsOptional

Container for schedule items. One invoice schedule can have at most 50 invoice schedule items.

specificSubscriptionslist of objectsOptional

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

statusenumOptional

The status of the invoice schedule.

Allowed values:

totalAmountdoubleOptional

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.

unbilledAmountdoubleOptional

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

organizationLabelstringOptional

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

Errors

4XX

Client Request Error

500

Internal Server Error