Create a custom filter through Bill Run Advanced Filter

Last updated
Save as PDF

You can define your custom filter using the Account Filter, Subscription Filter, and Rate Plan Charge Filter. You can define the custom filter only through the Zuora UI.

The Bill Run Advanced Filter feature is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at Zuora Global Support.

Filter logic

For your defined custom filter, the system proceeds from account to subscription and then charges. If you do not specify the Account Filter, all accounts in the tenant are picked up, and then the system will check your defined subscription condition. If you do not specify the Account Filter and Subscription Filter, all accounts and subscriptions in the tenant are picked up, and then the system will check your defined charge condition. Besides this logic, you can read Common use cases of Bill Run Advanced Filter to better understand the filtering logic.

Default conditions and billed objects

By default, the custom filter may include or exclude some conditions. For example, if you specify some accounts in the custom filter, order line items and invoice schedules in the accounts will be billed.

Bill order line items and invoice schedules

We don’t support defining a custom filter for order line items and invoice schedules directly. However, if an account or subscription is picked up, the associated order line items and invoice schedules will be picked and billed by default if they meet the target date. For more information, see Bill Run Advanced Filter involving order line items and invoice schedules.

Other conditions excluded or included by default

The following conditions are excluded or included for your custom filter by default:

Account Filter:
- Accounts with Draft and Canceled statuses are excluded by default; you do not have to specify these statuses in your filter.
- Only Accounts with the Active status can be processed by default.
Subscription Filter:
- Subscriptions with Draft and Expired statuses are excluded by default; you do not have to specify these statuses in your filter.
- Subscriptions with other statuses are processed.
Rate Plan Charge Filter:
- Charges with the isProcessed flag as True are excluded by default.
- If your defined custom filter picks up a regular charge, the discount charges applied to this regular charge are automatically picked up by default if the discount charges are eligible. However, if you define custom filters directly for discount charges, those filters will be skipped. In other words, the custom filters must be defined for regular charges instead of discount charges.

Create a custom filter through Bill Run Advanced Filter

To create a custom filter, complete the following steps:

Navigate to Billing > Bill Runs in the navigation section and click New Scheduled Bill Run or New Bill Run.
(Optional): Enter a name for the bill run.
Select Advanced Filter. The Account Filter is added by default. To add more filters in your custom field, do one of the following:
- Click filters under the Quick Filters at the right. These filters are default filters.
- Click + Add Subscription Filter, + Add Rate Plan Charge Filter, or both. Then, click Use an existing filter at the left under Account Filter, Subscription Filter, or Rate Plan Charge Filter, and click in the search box to select an existing filter. These filters are previously saved. To replace a new filter, click Choose another filter.
- Click + Add Subscription Filter, + Add Rate Plan Charge Filter, or both buttons to create filters. Then, add condition groups, conditions, and fields from scratch.
The composite condition (including the conditions and condition groups) of each filter in your custom filter has AND logic between them.
For the Account Filter, Subscription Filter, or Rate Plan Charge Filter, click + Add Condition or + Add Group.
- For a group, select the AND or OR operator and define multiple conditions.
- For a condition, select a standard or custom field of the Account, Subscription, or Rate Plan Charge object, select an operator, and specify the field value. The available operators (for example, “=” and “>”) vary for different fields.
  - For standard fields, see Account Data Source, Subscription Data Source, and Rate Plan Charge Data Source.
  - For custom fields, see Manage custom fields with the Object Manager.
- For a group or condition, click the copy icon to duplicate a new one. Alternatively, you can click the delete icon to delete a group or condition, and then add a new one.
  
  Read important notes before creating your conditions.
(Optional) You can save each of the preceding filters for future use. Click Save filter as under Account Filter, Subscription Filter, or Rate Plan Charge Filter at the left, enter a filter name in the Save Filter dialogue that opens, and click Save.

After creating the custom filter, continue to configure the Bill Run Dates or Schedule Dates to complete a bill run. See step 4 in Create bill runs.

Important notes

If you do not specify Account Filter, all accounts in your tenant are picked up, and if you do not specify Account Filter and Subscription Filter, all accounts and subscriptions in your tenant are picked up.
Each group is a condition group consisting maximum of 10 conditions. You can create a maximum of two layers of conditions or condition groups for each filter.
Avoid using the AND operator incorrectly. See the examples of incorrect use of the AND operator.
If you select a field but leave its value empty, the field with the empty value still forms a condition and becomes part of your custom filter. For example, for the condition CreatedById = '' defined in the Subscription Filter section, subscriptions whose CreatedById field has an empty value will be picked up.