Sign in
Bill Run

Create a bill run

Creates an ad-hoc bill run or a scheduled bill run. Support the following:

  • Create ad-hoc or scheduled bill runs by batch
  • Create ad-hoc or scheduled bill runs by account
  • Create a bill run by subscription
  • Create ad-hoc or scheduled bill runs by custom filter combining the Account, Subscription, and Rate Plan objects.

To use this operation, you must have the <a href="https://docs.zuora.com?resourceId=platform-billing-roles" target="_blank">Create Bill Runs billing permission</a>.

Notes

When using this operation to create bill runs, keep the following notes in mind:

  • When creating bill runs by batch, you must specify the batches field and do not specify billRunFilters field. When creating bill runs by account, subscription, or custom filter, you must specify the billRunFilters field and do not specify the batches field.
  • When creating bill runs by account, only one single account is allowed. All subscription under the account are picked up.
  • When creating a bill run by subscription, all subscriptions must belong to the same account. At most 50 subscriptions are allowed.
  • If more than 500 bill runs created through this operation are in Pending status, you cannot use this operation to create any more bill runs.
  • When you use the in operator in an Account, Subscription, or Charge filter in billRunFilters, you can specify a maximum of 500 values in the list. If any in condition contains more than 500 values, the request fails validation, an error is returned, and the Bill Run is not started. This limit applies only to the in operator in Advanced Filters and does not limit the total number of accounts, subscriptions, or charges that the Bill Run can process.
post/v1/bill-runs

Headers

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.

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

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

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-Track-Idstring

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

Zuora-Entity-Idsstring

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 should not set this header.

Zuora-Org-Idsstring

Comma separated IDs. If you have <a href="https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org" target="_blank">Zuora Multi-Org</a> 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.

Zuora-Versionstring

The minor API version.

For a list of available minor versions, see API upgrades.

Request body

autoEmailboolean

Whether to automatically send emails after Auto-Post is complete.

Note: To use this field, you must first set the <a href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/billing-settings-configuration/general-billing-settings/define-billing-rules" target="_blank">Support Bill Run Auto-Post?</a> billing rule to Yes through the Zuora UI.

autoPostboolean

Whether to automatically post the bill run after the bill run is created.

Note: To use this field, you must first set the <a href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/billing-settings-configuration/general-billing-settings/define-billing-rules" target="_blank">Support Bill Run Auto-Post?</a> billing rule to Yes through the Zuora UI.

autoRenewalboolean

Whether to automatically renew auto-renew subscriptions that are up for renewal.

batchesstring[]

The batch of accounts for this bill run.

You can only specify either this field or the billRunFilters field.

Values: AllBatches or an array of Batch*n* where n is one of numbers 1 - 50, for example, Batch7.

Note: By default, you have 50 configurable account batches. To increase the limit to 200 batches, you must have the <a href="https://docs.zuora.com/en/entitlements/current-entitlements/performance-booster-elite" target="_blank">Performance Booster Elite</a> package.

billCycleDaystring

The day of the bill cycle. This field is only valid if the batches field is specified.

Values:

  • AllBillCycleDays or one of numbers 1 - 31 for an ad-hoc bill run
  • AllBillCycleDays, one of numbers 1 - 31, or AsRunDay for a scheduled bill run
billRunTypestring

The type of the bill run. If you do not specify any value for this field, the default value is Regular.

  • You can use this field only if the "Catch-Up Bill Run" feature is enabled.
  • You must specify this field to create a catch up bill run.

Values:

  • Regular
  • CatchUp
chargeTypeToExcludestring[]

The types of the charges to be excluded from the generation of billing documents. You can specify at most two charge types in the array.

includeSubscriptionsboolean

Indicates whether to bill subscriptions in the bill run.

includeOrderLineItemsboolean

Indicates whether to bill order line items in the bill run.

invoiceDatestring date

The invoice date for the bill run.

  • When creating an ad-hoc bill run, if you do not specify any value for this field, the default value is the current date.
  • When creating a scheduled bill run, if you do not specify any value for this field, the invoice date is the value of the repeatFrom field.

Note: You can use one of the following methods to specify the invoice date:

  • Specify invoiceDate
  • Specify invoiceDateMonthOffset and InvoiceDateDayOfMonth
invoiceDateMonthOffsetinteger

The month offset of invoice date for this bill run compared to bill run execution date.

Notes:

  • This field is only valid when the repeatType field is set to Monthly.
  • You can use one of the following methods to specify the invoice date:
    • Specify invoiceDate
    • Specify invoiceDateMonthOffset and InvoiceDateDayOfMonth
invoiceDateDayOfMonthinteger

The day of month of invoice date for this bill run. Specify a day of the month. If you specify 31, even though the month doesn't have 31, for example, February or April, the date recurs on the end day of each scheduled month.

Notes:

  • This field is only valid when the repeatType field is set to Monthly.
  • You can use one of the following methods to specify the invoice date:
    • Specify invoiceDate
    • Specify invoiceDateMonthOffset and InvoiceDateDayOfMonth
namestring

The name of the bill run.

noEmailForZeroAmountInvoiceboolean

Whether to suppress emails for invoices with zero total amount generated in this bill run after the bill run is complete.

It is best practice to not send emails for invoices with zero amount.

targetDatestring date

The target date for this bill run.

  • You must specify this field when creating an ad-hoc bill run.
  • For scheduled bill runs, if you do not specify any value for this field, the target date is the value of the repeatFrom field.
targetDateMonthOffsetinteger

The month offset of target date for this bill run compared to bill run execution date.

Note: This field is only valid when the repeatType field is set to Monthly.

targetDateDayOfMonthinteger

The day of month of target date for this bill run. Specify a day of the month. If you specify 31, even though the month doesn't have 31, for example, February or April, the date recurs on the end day of each scheduled month.

Note: This field is only valid when the repeatType field is set to Monthly.

Example request

{
  "batches": null,
  "billRunFilters": [
    {
      "filterType": "FilterCondition",
      "objectType": "Account",
      "condition": {
        "relation": "and",
        "conditions": [
          {
            "field": "BillCycleDay",
            "operator": "neq",
            "value": "{{AsRunDay}}"
          }
        ]
      }
    }
  ],
  "autoRenewal": false,
  "noEmailForZeroAmountInvoice": false,
  "autoPost": true,
  "autoEmail": false,
  "chargeTypeToExclude": [],
  "billCycleDay": null,
  "invoiceDate": "2026-01-01",
  "targetDate": "2026-01-01",
  "billRunType": "Regular",
  "name": ""
}

Response

OK

autoEmailboolean

Whether to automatically send emails after Auto-Post is complete.

autoPostboolean

Whether to automatically post the bill run after the bill run is created.

autoRenewalboolean

Whether to automatically renew auto-renew subscriptions that are up for renewal.

batchesstring[]

The batch of accounts for this bill run, this field can not exist with billRunFilters together.

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

billCycleDaystring

The day of the bill cycle, this field is only valid when batches is specified.

Values:

  • AllBillCycleDays or one of numbers 1 - 31 for an ad-hoc bill run
  • AllBillCycleDays, one of numbers 1 - 31, or AsRunDay for a scheduled bill run
billRunNumberstring

The number of the bill run.

chargeTypeToExcludestring[] nullable

The types of the charges to be excluded from the generation of billing documents.

createdByIdstring

The ID of the user who created the bill run.

createdDatestring

The date and time when the bill run was created.

includeSubscriptionsboolean

Indicates whether to bill subscriptions in the bill run.

includeOrderLineItemsboolean

Indicates whether to bill order line items in the bill run.

idstring

The unqie ID of the bill run.

invoiceDatestring date

The invoice date for this bill run, only valid for ad-hoc bill runs.

invoiceDateOffsetinteger nullable

The offset compared to bill run execution date, only valid for scheduled bill runs.

invoiceDateMonthOffsetinteger nullable

The month offset of invoice date for this bill run compared to bill run execution date.

Note: This field is only valid when the repeatType field is set to Monthly. When using the invoiceDateMonthOffset and invoiceDateDayOfMonth fields, do not use the invoiceDateOffset field, and vice versa.

invoiceDateDayOfMonthinteger nullable

The day of month of invoice date for this bill run. Specify a day of the month. If you specify 31, even though the month doesn't have 31, for example, February or April, the date recurs on the end day of each scheduled month.

Note: This field is only valid when the repeatType field is set to Monthly. When using the invoiceDateMonthOffset and invoiceDateDayOfMonth fields, do not use the invoiceDateOffset field, and vice versa.

namestring

The name of the bill run.

noEmailForZeroAmountInvoiceboolean

Whether to suppress emails for invoices with zero total amount generated in this bill run after the bill run is complete.

scheduledExecutionTimestring nullable

The scheduled execution time for a bill run.

status'Pending' | 'Processing' | 'Completed' | 'Error' | 'Canceled' | 'Posted' | 'PostInProgress' | 'CancelInProgress' | 'RemoveInProgress' | 'Paused'

The status of the bill run.

targetDatestring date

The target date for this bill run, only valid for ad-hoc bill runs.

targetDateOffsetinteger nullable

The offset compared to bill run execution date, only valid for scheduled bill runs.

targetDateMonthOffsetinteger nullable

The month offset of target date for this bill run compared to bill run execution date.

Note: This field is only valid when the repeatType field is set to Monthly. When using the targetDateMonthOffset and targetDateDayOfMonth fields, do not use the targetDateOffset field, and vice versa.

targetDateDayOfMonthinteger nullable

The day of month of target date for this bill run. Specify a day of the month. If you specify 31, even though the month doesn't have 31, for example, February or April, the date recurs on the end day of each scheduled month.

Note: This field is only valid when the repeatType field is set to Monthly. When using the targetDateMonthOffset and targetDateDayOfMonth fields, do not use the targetDateOffset field, and vice versa.

updatedByIdstring

The ID of the user who last updated the bill run.

updatedDatestring

The date and time when the bill run was last updated.

Example response

{
  "id": "8a90ff929bb9d7c0019bbc7d34ec2c5f",
  "autoEmail": false,
  "autoPost": false,
  "autoRenewal": false,
  "billCycleDay": "AllBillCycleDays",
  "billRunNumber": "BR-00007954",
  "name": "Bill subscriptions matched the dynamic invoice date 2025-06-01",
  "invoiceDate": "2025-06-01",
  "noEmailForZeroAmountInvoice": false,
  "status": "Pending",
  "targetDate": "2025-06-01",
  "targetDateOffset": null,
  "invoiceDateOffset": null,
  "scheduledExecutionTime": null,
  "createdById": "e1187a1f28c8487ca6b40c40ffb10853",
  "createdDate": "2026-01-14 04:31:20",
  "updatedById": "e1187a1f28c8487ca6b40c40ffb10853",
  "updatedDate": "2026-01-14 04:31:20",
  "batches": [
    "AllBatches"
  ],
  "chargeTypeToExclude": null,
  "billRunFilters": [
    {
      "filterType": "FilterCondition",
      "accountId": null,
      "subscriptionId": null,
      "invoiceScheduleId": null,
      "invoiceScheduleItemId": null,
      "objectType": "Subscription",
      "condition": {
        "field": null,
        "operator": null,
        "value": null,
        "conditions": [
          {
            "field": "billRunEffectiveDate__c",
            "operator": "lte",
            "value": "{{InvoiceDate}}",
            "conditions": [],
            "relation": null
          }
        ],
        "relation": "and"
      }
    }
  ],
  "schedule": null,
  "invoiceDateMonthOffset": null,
  "invoiceDateDayOfMonth": null,
  "targetDateMonthOffset": null,
  "targetDateDayOfMonth": null,
  "includeSubscriptions": true,
  "includeOrderLineItems": true,
  "success": true
}

Changes

No recorded changes to this endpoint across all 4 revisions of this API.