# CRUD: Retrieve a bill run

Retrieves information about a bill run.
Business operations depending on the completion of the bill run will not be available while the bill run query returns `PostInProgress`. Upon completion of the bill run, a query will return `Posted`.

Endpoint: GET /v1/object/bill-run/{id}
Version: 2026-09-11

## Path parameters:

  - `id` (string, required)
    Object id

## Query parameters:

  - `fields` (string)
    Object fields to return

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

  - `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](https://developer.zuora.com/api-references/api/operation/createToken).

  - `Zuora-Entity-Ids` (string)
    An entity ID. If you have [Zuora Multi-entity](https://docs.zuora.com?resourceId=platform-multi-entity-overview) 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)
    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)
    Zuora WSDL version number.

## Response 200 fields (application/json):

  - `Id` (string)
    ID of the object.
**Character limit:** 32
**Values:** automatically generated

  - `AutoEmail` (boolean)
    Determines whether to auto send email or not once the bill run completes.
**Note:** You must enable the [Support Bill Run Auto-Post Billing](https://docs.zuora.com?resourceId=billing-define-billing-rules) rule to pass this field.

  - `AutoPost` (boolean)
    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](https://docs.zuora.com?resourceId=billing-define-billing-rules) rule to pass this field.

  - `AutoRenewal` (boolean)
    Determines whether to auto renew subscription or not by this bill run once the bill run completes.

  - `Batch` (string)
    Batch of accounts for this bill run.
**Character limit:** 20
**Values:** AllBatches or Batchn where n is a number between 1 and 50.

  - `Batches` (string)
    The specific batches of customer accounts to be included in the bill run.
**Note**: To use this field, you must set the `X-Zuora-WSDL-Version` request header to `102` or later. Otherwise, an error occurs.
**Character limit:** 20
**Values:** `AllBatches`, `Batch`*n* or an array of `Batch`*n* where *n* is a number between 1 and 50

  - `BillCycleDay` (string)
    The day of the bill cycle.
**Character limit:** 32
**Values:** `AllBillCycleDays` or 01 - 31.

  - `BillRunNumber` (string)
    Number of the bill run.
**Character limit:** 50
**Values:** automatically generated

  - `CreatedById` (string)
    The user ID of the person who created the bill run.
**Character limit:** 32
**Values:** automatically generated

  - `CreatedDate` (string)
    The date and time when the bill run was created.
**Character limit:** 29
**Values:** automatically generated

  - `NoEmailForZeroAmountInvoice` (boolean)
    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).

  - `ExecutedDate` (string)
    The date and time when the bill run was executed.

  - `InvoiceDate` (string)
    Invoice date for this bill run.
**Character limit:** 29

  - `InvoicesEmailed` (boolean)
    Indicates whether the invoice has been sent or not.
**Values:** automatically generated

  - `LastEmailSentTime` (string)
    The last time emails were sent for this bill run.
**Character limit:** 29
**Values:** automatically generated

  - `NumberOfAccounts` (integer)
    The number of accounts processed by this bill run.
**Values:** automatically generated

  - `NumberOfInvoices` (integer)
    The number of invoices generated by this  run.
**Values:** automatically generated

  - `AccountId` (string)
    ID of the account used for single account bill run.
**Character limit:** 32

  - `Status` (string)
    The status for this bill run. See [Status Types](https://docs.zuora.com?resourceId=billing-bill-run-status-types) for more information.
    Enum: "Pending", "Processing", "Completed", "Error", "Canceled", "Posted", "PostInProgress", "CancelInProgress", "RemoveInProgress", "Paused"

  - `TargetDate` (string)
    Target date for this bill run. See [Create Bill Run](https://docs.zuora.com?resourceId=billing-bill-runs-creation) for more information.
**Character limit:** 29

  - `UpdatedById` (string)
    The user ID of the person who last updated the bill run.
**Character limit:** 32
**Values:** automatically generated

  - `UpdatedDate` (string)
    The date and time when the bill run was last updated.
**Character limit:** 29
**Values:** automatically generated

## Response 200 headers (application/json):

  - `Content-Encoding` (string)
    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-Limit` (string)
    The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.

  - `RateLimit-Remaining` (number)
    The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.

  - `RateLimit-Reset` (number)
    The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.

  - `Zuora-Request-Id` (string)
    The Zuora internal identifier of the API call. You cannot control the value of this header.

  - `Zuora-Track-Id` (string)
    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.

## Response 401 fields (application/json):

  - `message` (string)
    Error message.
If the error message is "Authentication error", ensure that the `Authorization` request header contains valid authentication credentials, then retry the request. See [Authentication](https://developer.zuora.com/rest-api/general-concepts/authentication/) for more information.
If the error message is "Failed to get user info", retry the request.

## Response 401 headers (application/json):

  - `Content-Encoding` (string)
    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-Limit` (string)
    The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.

  - `RateLimit-Remaining` (number)
    The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.

  - `RateLimit-Reset` (number)
    The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.

  - `Zuora-Request-Id` (string)
    The Zuora internal identifier of the API call. You cannot control the value of this header.

  - `Zuora-Track-Id` (string)
    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.

  - `WWW-Authenticate` (string)
    The value of this header is:

```
Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API
```
    Enum: "Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API"

## Response 404 fields (application/json):

  - `done` (boolean)

  - `records` (array)

  - `size` (integer)

## Response 404 headers (application/json):

  - `Content-Encoding` (string)
    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-Limit` (string)
    The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.

  - `RateLimit-Remaining` (number)
    The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.

  - `RateLimit-Reset` (number)
    The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information.

  - `Zuora-Request-Id` (string)
    The Zuora internal identifier of the API call. You cannot control the value of this header.

  - `Zuora-Track-Id` (string)
    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.

## Response 200 examples:

  - `response` (unknown)

## Response 401 examples:

  - `response` (unknown)

## Response 404 examples:

  - `response` (unknown)