Skip to content
/Bill Runs

Bill Runs

Bill runs automatically create invoices for your customers on a set schedule, as well as create invoices for your customers, as needed. A bill run gathers information from one or more customer accounts and generates invoices for those accounts. The operations in this section allows you to create, update, get, or delete bill runs.

Operations

Retrieve a bill run

Request

Retrieves the bill run information with the given ID.

Security
bearerAuth
Path
bill_run_idstringrequired

Identifier for the bill run, either bill_run_number or bill_run_id

Query
fields[]Array of strings

Allows you to specify which fields are returned in the response.

Accepted values `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `account_id`, `email`, `post`, `renew`, `batches`, `day_of_month`, `charges_excluded`, `invoice_date`, `email_zero_amount_invoices`, `target_date`, `bill_run_number`, `bill_run_time`, `invoices_sent`, `last_invoice_sent_time`, `accounts_processed`, `invoices_generated`, `credit_memos_generated`, `state`, `name`
Example:fields[]=id,created_time
bill_run.fields[]Array of stringsdeprecated

Allows you to specify which fields are returned in the response.

Accepted values `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `account_id`, `email`, `post`, `renew`, `batches`, `day_of_month`, `charges_excluded`, `invoice_date`, `email_zero_amount_invoices`, `target_date`, `bill_run_number`, `bill_run_time`, `invoices_sent`, `last_invoice_sent_time`, `accounts_processed`, `invoices_generated`, `credit_memos_generated`, `state`, `name`
Example:bill_run.fields[]=id,created_time
expand[]Array of strings

Allows you to expand responses by including related object information in a single call. See the Expand responses section of the Quickstart API Tutorials for detailed instructions.

filter[]Array of strings

A case-sensitive filter on the list. See the Filter lists section of the Quickstart API Tutorial for detailed instructions.
Note that the filters on this operation are only applicable to the related objects. For example, when you are calling the "Retrieve a billing document" operation, you can use the filter[] parameter on the related objects such as filter[]=items[account_id].EQ:8ad09e208858b5cf0188595208151c63

page_sizeinteger, [ 1 .. 99 ]

The maximum number of results to return in a single page. If the specified page_size is less than 1 or greater than 99, Zuora will return a 400 error.

Headers
zuora-track-idstring

A custom identifier for tracking API requests. If you set a value for this header, Zuora returns the same value in the response header. This header enables you to track your 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 ("), or quote (').

asyncboolean

Making asynchronous requests allows you to scale your applications more efficiently by leveraging Zuora's infrastructure to enqueue and execute requests for you without blocking. These requests also use built-in retry semantics, which makes them much less likely to fail for non-deterministic reasons, even in extreme high-throughput scenarios. Meanwhile, when you send a request to one of these endpoints, you can expect to receive a response in less than 150 milliseconds and these calls are unlikely to trigger rate limit errors. If set to true, Zuora returns a 202 Accepted response, and the response body contains only a request ID.

Default:false
zuora-entity-idsstring

An entity ID. If you have Multi-entity enabled and the authorization token is valid for more than one entity, you must use this header to specify which entity to perform the operation on. If the authorization token is only valid for a single entity or you do not have Multi-entity enabled, you do not need to set this header.

idempotency-keystring

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. This idempotency key should be a unique value, and the Zuora server identifies subsequent retries of the same request using this value. For more information, see Idempotent Requests.

accept-encodingstring

Include a accept-encoding: gzip header to compress responses, which can reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes. For more information about this header, see Request and Response Compression.

content-encodingstring

Include a content-encoding: gzip header to compress a request. Upload a gzipped file for the payload if you specify this header. For more information, see Request and Response Compression.

zuora-org-idsstring

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.

cURL
curl -i -X GET \
  'https://rest.test.zuora.com/v2/bill_runs/{bill_run_id}?fields%5B%5D=id%2Ccreated_time&bill_run.fields%5B%5D=id%2Ccreated_time&expand%5B%5D=string&filter%5B%5D=string&page_size=1' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'accept-encoding: string' \
  -H 'async: false' \
  -H 'content-encoding: string' \
  -H 'idempotency-key: string' \
  -H 'zuora-entity-ids: string' \
  -H 'zuora-org-ids: string' \
  -H 'zuora-track-id: string'

Responses

Default Response

Headers
ratelimit-limitstring

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

ratelimit-remainingnumber

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

ratelimit-resetnumber

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

zuora-request-idstring

Zuora’s internal identifier for this request.

zuora-track-idstring

A user-supplied identifier for this request. If you supply a zuora-track-id as a request header, Zuora returns the zuora-track-id as a response header.

Bodyapplication/json
idstring

Unique identifier for this object.

updated_by_idstringread-only

Unique identifier of the Zuora user who last updated the object

updated_timestring, (date-time)read-only

The date and time when the object was last updated in ISO 8601 UTC format.

created_by_idstringread-only

Unique identifier of the Zuora user who created the object

created_timestring, (date-time)read-only

The date and time when the object was created in ISO 8601 UTC format.

custom_fieldsobject(CustomFields)

Set of user-defined fields associated with this object. Useful for storing additional information about the object in a structured format.

custom_objectsobjectread-only

The custom objects associated with a Zuora standard object.

account_idstring

Identifier of the customer account to bill.

emailboolean

If set to true, invoices will be automatically emailed to customers.

postboolean

Indicates whether to automatically post a billing document after it is created.

renewboolean

If set to true, subscriptions will be automatically renewed.

day_of_monthstring

The day of the month to bill multiple customer accounts.

bill_run_numberstring

Human-readable identifier for this object.

bill_run_timestring, (date-time)

The date and time on which this bill run starts.

invoice_datestring, (date)

The date displayed on the invoice.

Example:"2022-01-01"
target_datestring, (date)

All unbilled items on or before this date are included in this bill run.

Example:"2023-01-01"
statestring

Status of the bill run.

Enum:"processed""pending""completed""canceled""posted""failed""processing""postInProgress""cancelInProgress""removeInProgress"
batchesstring

Identifier of the customer account batch to be included in this bill run.

charges_excludedstring

Type of the charge to be excluded from the bill run.

email_zero_amount_invoicesboolean

If set to false, invoices for zero amounts will not be emailed to customers.

invoices_sentboolean

Indicates whether the invoices have been automatically sent to customers.

last_invoice_sent_timestring, (date)

The date when the last invoice was sent.

Example:"2023-01-01"
accounts_processedinteger

Number of accounts billed from this bill run.

invoices_generatedinteger

Number of invoices generated from this bill run.

credit_memos_generatedinteger

Number of credit memos generated from this bill run.

namestring

The name of the bill run.

Response
{
  "id": "8ad08ccf8437067601843a7af4e64rq3",
  "updated_by_id": "2c92c0946a6dffc0016a7faab604299b",
  "updated_time": "2023-01-12T11:44:23-08:00",
  "created_by_id": "2c92c0946a6dffc0016a7faab604299b",
  "created_time": "2023-01-12T11:43:54-08:00",
  "custom_fields": {},
  "custom_objects": {},
  "email": false,
  "post": false,
  "renew": true,
  "day_of_month": "01",
  "bill_run_number": "BR-00000066",
  "bill_run_time": "2023-01-12T11:43:55-08:00",
  "invoice_date": "2022-01-12",
  "target_date": "2022-01-12",
  "state": "completed",
  "batches": "AllBatches",
  "charges_excluded": "OneTime",
  "email_zero_amount_invoices": true,
  "invoices_sent": false,
  "accounts_processed": 5,
  "invoices_generated": 4,
  "credit_memos_generated": 1
}