The below settings determine how the system behaves in regards to proration, such as how proration credits are assigned. The following proration settings can be set.
Proration Settings
Overview
Note: It is recommended that you use the default value if the setting does not apply.
Proration Settings
Below is a list of proration settings, their descriptions, default values, and where the parameter can be set in the UI.
| Parameter Name | Description | Values | Where to Set |
| Display Delta Values for Proration | Display delta values for proration (True = "Simple Statements." False = "Standard Statements"). |
True False (Default) |
Configuration > Billing > Invoice Settings |
| Do Prorated Invoicing on Reg | Provides the ability to create a prorated invoice and collect from a newly created account when created via the create_acct_complete API and an alternate billing date or day is passed in. |
True False (Default) |
Configuration > Billing > Invoice Settings |
| Do Prorate on Plan Change | If a plan change is made on an account, the customer will be charged a prorated amount. |
True (Default) False |
Configuration > Billing > Invoice Settings |
| Invoice Unbilled Usage During Proration= | Controls whether the unbilled usage should be invoiced during mid-term plan termination. (False = do not allow invoicing the unbilled usage during proration). |
True False (Default) |
Configuration > Billing > Invoice Settings |
| Prorate Bill Only Thru Contract End Date | Governs whether to use the contract end date to decide the proration period for purchased plans. |
True (Default) False |
Configuration > Billing > Contracts Settings |
| Prorate Cancellation Fee on Early Termination | Governs whether to apply a full or prorated fee when an account is eligible for early cancellation fees. |
True False (Default) |
Configuration > Billing > Invoice Settings |
| Proration Credit by Service Type | Drives how proration credits are assigned. (False = proration credits are not separated and include "service + tax" component. True = proration credits are separated by similar service type or group of services). |
True False (Default) |
Configuration > Billing > Invoice Settings |
| Proration on credit options | Toggles Rounded and Unrounded amount options for credits and charges on services during proration process. |
(1) Unrounded amount should be used during prorated charge/credit calculation |
Configuration > Billing > Invoice Settings |
| Proration on net charges options | Governs which objects will use net charges when calculating proration. |
Charges, Tax, Coupon-based credits, and Discounts (Default) Charges, Tax, Coupon-based credits, Discounts, and all Service Credits |
Configuration > Billing > Invoice Settings |
| Net-Negative Pro-Ration Action | When a proration action (e.g., cancellation or downgrade) occurs that results in net negative charges, this parameter allows you to configure whether to issue service credit, cash credit, refund or discard. |
Produce Corresponding Service Credit (Default) Produce Corresponding Cash Credit Produce No Credit Produce Cash Credit for Net-Negative Amount |
Configuration > Billing > Invoice Settings |
| Refund for Proration Credit Action | Determines if an eligible refundable payment should be issued an automated refund for "Cancellation" use case or "Cancellation or Downgrade" use cases. A payment is considered eligible if the payment is a fully paid invoice. If there are more than one (1) payments applied to an invoice or if an attempted refund fails, then an automated refund will not be issued. On "Refund for Cancellation or Downgrade" option, supported downgrade use cases include: unit of subscription change, a rate tier change, or a subscription change. This parameter acts as an extension of cash credit options ("Produce Cash Credit for Net Negative Amount", "Produce Corresponding Cash Credit") on "Net Negative Pro-ration Action" under "Invoice Settings". |
No Refund (Default) Refund for Cancellation Refund for Cancellation or Downgrade |
Configuration > Payments > Payment Settings |
| Usage Units Sent to Tax Engine During Proration | Governs what kind of usage units should be sent to tax engines during proration. |
Base (Default) Fixed Prorated |
Configuration > Billing > Taxation Settings |