Create an invoice schedule

Creates an invoice schedule.

Limitations

This API operation has the following limitations:

  • You can create at most 50 invoice schedule items in one request.

  • You can associate at most 10 orders with an invoice schedule in one request.

  • You can associate at most 300 subscriptions with an invoice schedule in one request, including those contained in orders and separate subscriptions.

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

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

Idempotency-Key
string <= 255 characters

Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types.

With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.

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
accountKey
string

The ID or number of the account associated with the invoice schedule.

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.

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.

Array of objects (scheduleItems)

Container for invoice schedule items. One invoice schedule can have at most 50 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.

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
post/v1/invoice-schedules
Request samples
application/json
{
  • "accountKey": "A00000007",
  • "additionalSubscriptionsToBill": [
    ],
  • "invoiceSeparately": false,
  • "notes": "2022 Billing Schedule",
  • "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
}