Overview
Threshold Billing allows you to invoice your customers when their unbilled orders reach a total greater than or equal to a specified threshold amount. Once the threshold is reached, an invoice is created, even on a date other than the anniversary date. You may decide to receive a notification from Aria whenever a customer is invoiced for unbilled orders. Then you can take your chosen action based on the notification. Threshold Billing applies to electronic payment methods and payment terms.
Example: You can create a threshold for $100 and assign it to your chosen accounts' billing groups. Then you may want to send those customers a statement or an invoice (with an optional but recommended statement for payment) when their unbilled orders reach $100. This will allow your customers to be aware of accumulated expenses that they will be charged for on their next anniversary date.
Please see Threshold Billing Use Cases for a few basic examples showing how to implement Threshold Billing.
Note:
- If you set Auto-Collect On Order Invoicing (under Configuration > Payments > Payment Settings) to True, a payment is immediately collected when an invoice is created after a threshold is reached (even if it's before the anniversary date).
- Threshold Billing features will be released in phases. In Phase 1:
- Threshold Billing is supported for only unbilled orders and not unbilled usage or parent/child balance transfers.
- Threshold Billing applies to only self pay plans. If you assign a threshold to a child account with a parent pay plan, no invoice will be created when that threshold is reached. Instead, for any unbilled order associated with a parent pay plan, the invoice will be created on the child account's anniversary date. Then the balance for that order will be transferred to the parent account. For more information, please see Parent-Child Account Best Practices.
Prerequisites
Before you can use Threshold Billing, you will need to:
Additional Threshold-related API Features
These additional API features apply to Threshold Billing:
Invoice Information
- When you call the get_invoice_details_m API and:
- Data for an invoice containing an order is returned; and
- The order total reached an assigned threshold:
- The Advance Period (order date range) may or may not be displayed on invoices as described below (see sample invoice with Advance Period included):
Use Case |
If... |
And |
Then... |
1 |
You place 1 or more orders using the create_order_m API.
|
For both use cases 1 and 2:
- <bill_immediately> is set to 0 or 1; and
- The orders are placed on the same or different days; and
- The order total does or does not reach any specified threshold.
|
The invoice created for the order will include the Advance Period. |
2 |
You place 1 or more orders using the create_order_with_plan_m API. |
The invoice created for the order will not include the Advance Period. |
Threshold Errors
The <threshold_billing_errors> output array is returned by these APIs: create_order_m and create_order_with_plan_m. This array returns threshold-related errors. Please see the documentation for those APIs for more information.
Important Notes
- Some account and plan instance statuses do not allow order creation and/or invoicing. Please see the Account Statuses and Plan Instance Statuses documentation for more information.
- If a plan is in dunning, you might not be able to create an unbilled order to be invoiced with that plan. Example: if a plan is in the suspended status due to dunning, you cannot create an unbilled order to be invoiced with that plan. Please see the Plan Instance Statuses documentation for more information.
- Currently, you can assign only 1 threshold to each billing group. However, for each account, you can assign the same threshold to different billing groups or assign a different threshold to each billing group.
- Invoices may still be created for orders even if an assigned threshold is not reached. Example:
- You assign a $100 threshold to an account's billing group.
- You call the create_order_m API to place an order for a $45 item and pass 1 into the <bill_immediately> field (this means that the order will be invoiced, even though it's below the threshold).
- A $45 invoice is created for the order.
- If you cancel an order, that will reduce the unbilled order balance.
Example: You have an account whose billing group's threshold is $200 and you create a $190 order, then you cancel the order. If you create a $10 order after that, no invoice will be generated because the canceled $190 order was removed from the unbilled order balance. The unbilled order balance is now $10, not $200 ($190 + $10). If you create a $190 order, an invoice will be generated because the $200 threshold was reached.
- Once an invoice is created based on reaching a threshold, the unbilled order balance is reset to $0. So if you void an invoice for an order before or after a payment is collected for that invoice, that will not reduce the unbilled order balance.
Example: You have an account whose billing group's threshold is $100 and you create a $150 order. Then an invoice is created because the threshold was reached. After that you create a $90 order, then you void the $150 invoice. The unbilled order balance is now $90, not -$60 ($90 - $150). If you create a $10 order, an invoice will be generated because the $100 threshold was reached.
- Only orders in the Order Filled status are included in the unbilled order balance. An order is put in the Order Filled status only if you:
- Call the create_order_m or create_order_with_plan_m API and set the <bill_immediately> field to 0; or
- Create an order in the Aria application and under Invoice Immediately?, select No and Allow this order's line items to be reflected on the next regularly schedule periodic invoice for this account; or
- Use the Aria application to change the Status of an order from Order Held to Order Filled. See Use Case 7 for more information.
- When you create an order using the create_order_m or create_order_with_plan_m API and pass a value into the <bill_immediately> field, that may override your setting for the Auto Bill Orders parameter (under Configuration > Billing > Invoice Settings).
- The total order amount before discounts, service credits, cash credits, surcharges, or taxes is considered when a threshold-based invoice is created.
Examples:
- You assign a $100 threshold to an account's billing group. Then the customer places a $100 order. If a $20 coupon is applied to the invoice, an invoice for $80 will be created for the order.
- You assign a $200 threshold to an account's billing group. Then the customer places a $185 order and a $30 inline or separate surcharge is added for a final total of $215. No invoice will be created for the order.
- You assign a $200 threshold to an account's billing group. Then the customer places a $200 order and a $20 inline or separate surcharge is added. A $220 invoice will be created for the order.
- You assign a $100 threshold to an account's billing group. Then the customer places a $95 order. If $10 in taxes are added to the order, no invoice will be created for that order.
- Be sure to set up a threshold for each required currency. You cannot assign a threshold to an account if the account currency and threshold's currency are different.
- You may want to set your thresholds based on how often you want to receive event notifications or communicate with your customers. This will allow you to avoid sending too many messages to the same customer who places many orders (example: multiple invoices will be created on the same day if a customer reaches the threshold several times in the same day). Set these parameters with the awareness that your customers may be invoiced and charged every time their unbilled orders reach your specified threshold:
- If you set Auto-Collect On Order Invoicing (under Configuration > Payments > Payment Settings) to True, a payment will be collected whenever an invoice is created after a threshold is reached.
- If you set Auto-Send Statement On Order Invoicing (under Configuration > Notifications > Notification Settings) to True, a statement will be sent to the customer whenever an invoice is created after a threshold is reached.
- Take note of the days until due (at the collection group or payment method level) that applies to the invoices created for orders. Threshold Billing honors the applicable number of days until due for payments to be collected after invoices are created. This means that a payment for an unbilled order that reached a threshold may be collected before the associated plan's anniversary date. Examples:
Use Case |
If...
|
And... |
Then... |
1 |
You set the days until due to 3 days after the invoice date.
|
For both use cases 1 and 2:
- A customer has a plan whose next anniversary date is 17 May 2021; and
- On 20 April 2021 you place an unbilled order that reaches the threshold.
|
The payment for the order will be collected on 23 April 2021. |
2 |
You set the days until due to 3 days after the end of the month.
|
The payment for the order will be collected on 3 May 2021. |
Statements
The 3 threshold-related fields listed below are available for you to include in your statement templates. These fields display any threshold information associated with order invoices included in a statement:
- Threshold Billing Rule Name: Rule Name that you used when you created the threshold
- Threshold Billing Rule Description: External Description that you used when you created the threshold
- Threshold Billing Rule Currency Amount: Amount that you entered when you created the threshold
Please contact Aria Customer Support if you want to include these 3 fields or any other information in your statement templates.
Here is a sample statement that contains the 3 fields listed above.
Account Comments
When you add a threshold to a billing group or remove a threshold from a billing group, those actions are included in the Recent Comments section on the Account Overview screen as shown in this example:

Audit Logs
To view Threshold Billing-related audit logs, follow the instructions described here.