CRUD: Create a bill run

Creates an ad hoc bill run or a single account or multiple customer accounts.

When creating a single account ad hoc bill run, your request must include AccountId and must not include Batch or BillCycleDay.

If more than 500 bill runs created by using this operation are in Pending status, no more bill runs can be created by using this operation.

Request
query Parameters
rejectUnknownFields
boolean
Default: false

Specifies whether the call fails if the request body contains unknown fields. With rejectUnknownFields set to true, Zuora returns a 400 response if the request body contains unknown fields. The body of the 400 response is:

{
    "message": "Error - unrecognised fields"
}

By default, Zuora ignores unknown fields in the request body.

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

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.

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.

Authorization
string

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

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

X-Zuora-WSDL-Version
string
Default: 79

Zuora WSDL version number.

Request Body schema: application/json
required
AccountId
string

ID of the account used for single account bill run.

This field is only required if you create ad hoc bill run for a single customer account.

Character limit: 32

InvoiceDate
required
string <date>

Invoice date for this bill run.

Character limit: 29

TargetDate
required
string <date>

Target date for this bill run. See Create Bill Run for more information.

Character limit: 29

AutoEmail
boolean
Default: false

Determines whether to auto send email or not by this bill run once the bill run completes.

Note: You must enable the Support Bill Run Auto-Post Billing rule to pass this field.

AutoRenewal
boolean
Default: false

Determines whether to auto renew subscription or not by this bill run once the bill run completes.

AutoPost
boolean
Default: false

Determines whether to auto post bill run or not once the bill run completes.

Note: You must enable the Support Bill Run Auto-Post Billing rule to pass this field.

ChargeTypeToExclude
string

Charge type or types to be excluded, separated with comma.

Possible Values: OneTime, Recurring, Usage, or a combination of these values.

Character limit: 50

NoEmailForZeroAmountInvoice
boolean
Default: false

Determines whether to suppress email for invoices with zero total or not for this bill run once the bill run completes. (Do not email invoices with 0 Invoice Total).

Batch
string
Default: "AllBatches"

Batch of accounts for this bill run.

When creating ad hoc bill run for multiple customer accounts, this field is only required if the BillCycleDay field is not specified.

Character limit: 20

Values: AllBatches or Batchn where n is a number between 1 and 50.

Note:

  • By default, you have 50 configurable account batches. To increase the limit to 200 batches, you must have the Performance Booster Elite package.
  • To use this field, you must set the X-Zuora-WSDL-Version request header to 101 or earlier. Otherwise, an error occurs.
Batches
string
Default: "AllBatches"

The specific batches of customer accounts to be included in the bill run.

You cannot set the Batches field to a value consisting of both AllBatches and Batchn. Otherwise, the INVALID_VALUE error occurs. For example, AllBatches,Batch3 is an invalid value for this field. Batch of accounts for this bill run.

Character limit: 20

Values: AllBatches, Batchn or an array of Batchn where n is a number between 1 and 50

Note:

  • By default, you have 50 configurable account batches. To increase the limit to 200 batches, you must have the Performance Booster Elite package.
  • To use this field, you must set the X-Zuora-WSDL-Version request header to 102 or later. Otherwise, an error occurs.
BillCycleDay
string

The day of the bill cycle.

When creating ad hoc bill run for multiple customer accounts, this field is only required if the Batch field is not specified.

Character limit: 32

Values: AllBillCycleDays or 01 - 31.

Responses
200
400
401
post/v1/object/bill-run
Request samples
application/json
{
  • "Batch": "Batch1",
  • "InvoiceDate": "2017-02-04",
  • "TargetDate": "2017-02-04"
}
Response samples
application/json
{
  • "Success": true,
  • "Id": "2c92c0f959d961e1015a0872b69a7347"
}