Absolute Billing Discount

The Absolute Billing Discount feature provides a straightforward way to apply a fixed discount to specific types of usage, such as calls to off-net destinations. This discount is applied during the billing cycle run and is based on the total amount of usage for the specified type.

Key features of the Absolute Billing Discount feature include:

Fixed Discount Application: The discount is applied as a fixed amount to the rated event, reducing the total billed amount for the customer. This approach simplifies the billing process and ensures a consistent discount value is applied.
Threshold Configuration: You can set the MIN and MAX thresholds for the total amount of usage for the specified type before applying the discount. This allows you to define the range within which the discount will be applied. For example, you can specify that the discount should only be applied when the total rated amount for a specific usage type is between a certain minimum and maximum threshold.
Event-Based Discount: The discount is always applied by creating a new discount event that reflects the discounted amount separately from the actual event. This provides flexibility in how the discount is tracked and reported.
Usage Type Specific: The discount can be applied to specific usage types, such as calls to off-net destinations, ensuring that the discount is relevant to the customer’s usage patterns.

Configuration in the GUI

This section describes the configuration of an Absolute Billing Discount in the GUI.

Item	Description
Discount	Enter Discount which will be applied.
Charge Min	Optionally, enter Minimum Charge for which Discount will be applied.
Charge Max	Optionally, enter Maximum Charge for which Discount will be applied.
Billing Discount Type	Type of the Billing Discount. On which level Base Amount is calculated. Possible values are: Subscription Subscriber Account Invoice
Pro-Rate when Not Charged	If checked, Discount is Pro-Rated. Applicable only for State Suspended when appropriate State Reason is flagged as Charged.
Pro-Rate Mode	Choose how Pro-Rate functionality behaves: Second - Pro-Ration is calculated with Seconds precision. Day - Pro-Ration is calculated effectively at the end of the Day. Last state valid at the end of the Day is considered. Noon - Pro-Ration is calculated effectively at the Noon. Last state valid at the Noon is considered. Customer Friendly - Pro-Ration is calculated as "Friendly" for customer on Day basis. If the one of the State at the Day is marked as Not Charged independent on any other State at the Day, entire Day is not charged. Provider Friendly - Pro-Ration is calculated as "Friendly" for customer on Day basis. If the one of the State at the Day is marked as Charged independent on any other State at the Day, entire Day is not charged.
Tax Included	If checked, Discount is inclusive Tax.
Tax	Choose Tax which will be applied.
Charging Class	Choose Charging Class which will be assigned to the Discount.
GL Code	Choose GL Code which will be assigned to the Discount. If no GL Code is chosen, GL Code which is configured on Charging Class level will be applied.
Validity	If you would like to limit validity of the Offer to some period, enter the length of the period.
Time Unit	Choose Time Unit for the Validity period. Pre-defined values are: Second Minute Hour Day Week Month Year
Include sub-classes	If checked, subordinate Charging Classes will be included in the evaluation of Discount application.
List of Charging Classes	Check all Charging Classes for which Discount will be applied.

Item

Description

Discount

Enter Discount which will be applied.

Charge Min

Optionally, enter Minimum Charge for which Discount will be applied.

Charge Max

Optionally, enter Maximum Charge for which Discount will be applied.

Billing Discount Type

Type of the Billing Discount. On which level Base Amount is calculated.

Possible values are:

Subscription
Subscriber
Account
Invoice

Pro-Rate when Not Charged

If checked, Discount is Pro-Rated. Applicable only for State Suspended when appropriate State Reason is flagged as Charged.

Pro-Rate Mode

Choose how Pro-Rate functionality behaves:

Second - Pro-Ration is calculated with Seconds precision.
Day - Pro-Ration is calculated effectively at the end of the Day. Last state valid at the end of the Day is considered.
Noon - Pro-Ration is calculated effectively at the Noon. Last state valid at the Noon is considered.
Customer Friendly - Pro-Ration is calculated as "Friendly" for customer on Day basis. If the one of the State at the Day is marked as Not Charged independent on any other State at the Day, entire Day is not charged.
Provider Friendly - Pro-Ration is calculated as "Friendly" for customer on Day basis. If the one of the State at the Day is marked as Charged independent on any other State at the Day, entire Day is not charged.

Tax Included

If checked, Discount is inclusive Tax.

Tax

Choose Tax which will be applied.

Charging Class

Choose Charging Class which will be assigned to the Discount.

GL Code

Choose GL Code which will be assigned to the Discount. If no GL Code is chosen, GL Code which is configured on Charging Class level will be applied.

Validity

If you would like to limit validity of the Offer to some period, enter the length of the period.

Time Unit

Choose Time Unit for the Validity period.

Pre-defined values are:

Second
Minute
Hour
Day
Week
Month
Year

Include sub-classes

If checked, subordinate Charging Classes will be included in the evaluation of Discount application.

List of Charging Classes

Check all Charging Classes for which Discount will be applied.

Configuration via the Spreadsheet API

Pre-Requisites

For the configuration of the Absolute Billing Discount, it is essential that the product is set up as a singleton. This setup implies that the product should only contain one service, which in this case is the Absolute Billing Discount.

Endpoint

The configuration API for managing absolute billing discounts is available at the following endpoint: {{url}}/loader/v1/absolute-billing-discounts/{absoluteBillingDiscount}.

The {absoluteBillingDiscount} is a placeholder for the unique identifier of the absolute billing discount product.

Payload

The following table lists the attributes of the payload for the absolute billing discount configuration.

Code (Line #1)	Name (Line #2)	Type	Description	Note
productCode	Product Code	String, Not null	The unique identifier for a product.
productServiceCode	Product Service Code	String, Not null	The unique identified for a specific service associated with a product.
versionCode	Version Code	String, Not null	The code indicating the version of an offer.
versionDescription	Version Description	String	A detailed description of the specific version of an offer.
offerName	Offer Name	String, Not null	The name of a specific offer.
offerCode	Offer Code	String, Not null	The unique code assigned to a specific offer.
offerDescription	Offer Description	String	A detailed description of the offer.
currency	Currency	String, Not null	The code of the currency associated with a specific offer.
priority	Priority	Number, Not null	Priority of the discount application.	The lower value, the higher priority during discount application.
validity	Validity	Number	The period during which an offer is valid.	Associated with Validity period.
validityPeriod	Validity period	String	The specific duration for which a discount remains valid. Allowed values are: SECOND MINUTE HOUR DAY WEEK MONTH YEAR
chargingClassApplied	Charging Class Applied	String, Not null	The specific charging class(es) applied.	Comma delimited list of charging classes applied.
subclassIncluded	Charging Class Applied to Sub-Classes	Boolean	Indicates whether the charging class is applied to sub-classes, related to Charging class applied.	Y = True N = False
chargingClass	Charging Class	String, Not null	The code of charging class assigned to an event.
tax	Tax	String, Not null	The code of tax assigned to the offer.
discount	Discount	Number, Not null	Discount applied. Absolute value.	Shifted by 6 decimal points. E.g. 1000000 = 1 EUR/USD/etc.
chargeMin	Charge Min	Number	The minimum charge applicable for the discount.	Shifted by 6 decimal points. E.g. 1000000 = 1 EUR/USD/etc.
chargeMax	Charge Max	Number	The maximum charge applicable for the discount.	Shifted by 6 decimal points. E.g. 1000000 = 1 EUR/USD/etc.
taxIncluded	Charge incl. Tax	Boolean	Related to Charge Min and Charge Max, indicates whether charges are inclusive tax.	Y = True N = False
proRateNotCharged	Pro-Rate Not Charged	Boolean	Indicates whether to Pro-Rate when State Reason is marked as 'Not Charged'.	Y = True N = False
proRateThresholds	Pro-Rate Thresholds	Boolean	Indicates whether to Pro-Rate Min a Max Thresholds.	Y = True N = False
glCode	GL Code	String, Not null	The General Ledger code associated with the offer.
billingDiscountType	Billing Discount Type	String, Not null	Type of the Billing Discount. On which level Base Amount is calculated. Allowed values are: SUBSCRIPTION SUBSCRIBER ACCOUNT INVOICE
eventGenerated	Generate Event	Boolean	Indicates whether an event is generated for the discount.	Y = True N = False
error	Error	String	Any errors associated with the configuration.	Only on the output.

Code (Line #1)

Name (Line #2)

Type

Description

Note

productCode

Product Code

String, Not null

The unique identifier for a product.

productServiceCode

Product Service Code

String, Not null

The unique identified for a specific service associated with a product.

versionCode

Version Code

String, Not null

The code indicating the version of an offer.

versionDescription

Version Description

String

A detailed description of the specific version of an offer.

offerName

Offer Name

String, Not null

The name of a specific offer.

offerCode

Offer Code

String, Not null

The unique code assigned to a specific offer.

offerDescription

Offer Description

String

A detailed description of the offer.

currency

Currency

String, Not null

The code of the currency associated with a specific offer.

priority

Priority

Number, Not null

Priority of the discount application.

The lower value, the higher priority during discount application.

validity

Validity

Number

The period during which an offer is valid.

Associated with Validity period.

validityPeriod

Validity period

String

The specific duration for which a discount remains valid.

Allowed values are:

SECOND
MINUTE
HOUR
DAY
WEEK
MONTH
YEAR

chargingClassApplied

Charging Class Applied

String, Not null

The specific charging class(es) applied.

Comma delimited list of charging classes applied.

subclassIncluded

Charging Class Applied to Sub-Classes

Boolean

Indicates whether the charging class is applied to sub-classes, related to Charging class applied.

Y = True
N = False

chargingClass

Charging Class

String, Not null

The code of charging class assigned to an event.

tax

Tax

String, Not null

The code of tax assigned to the offer.

discount

Discount

Number, Not null

Discount applied. Absolute value.

Shifted by 6 decimal points. E.g. 1000000 = 1 EUR/USD/etc.

chargeMin

Charge Min

Number

The minimum charge applicable for the discount.

Shifted by 6 decimal points. E.g. 1000000 = 1 EUR/USD/etc.

chargeMax

Charge Max

Number

The maximum charge applicable for the discount.

Shifted by 6 decimal points. E.g. 1000000 = 1 EUR/USD/etc.

taxIncluded

Charge incl. Tax

Boolean

Related to Charge Min and Charge Max, indicates whether charges are inclusive tax.

Y = True
N = False

proRateNotCharged

Pro-Rate Not Charged

Boolean

Indicates whether to Pro-Rate when State Reason is marked as 'Not Charged'.

Y = True
N = False

proRateThresholds

Pro-Rate Thresholds

Boolean

Indicates whether to Pro-Rate Min a Max Thresholds.

Y = True
N = False

glCode

GL Code

String, Not null

The General Ledger code associated with the offer.

billingDiscountType

Billing Discount Type

String, Not null

Type of the Billing Discount. On which level Base Amount is calculated.

Allowed values are:

SUBSCRIPTION
SUBSCRIBER
ACCOUNT
INVOICE

eventGenerated

Generate Event

Boolean

Indicates whether an event is generated for the discount.

Y = True
N = False

error

Error

String

Any errors associated with the configuration.

Only on the output.