Create a customizable usage-based billing product for usage-based charging
This endpoint allows you to create a new usage-based billing product that charges customers based on their actual consumption. This flexible billing model can be customized with various settings to define how consumption is tracked, billed, and reported.
Key Features
- Create products with usage-based pricing
- Specify units of measurement
- Choose from multiple pricing models
- Define applicable usage ranges
Read more about the different pricing models and how to set them up here.
Special Considerations for Percentage and Percentage-step Models
In percentage and percentage-step pricing models, unit ranges (from - to ranges), Included units and consumed/used unit counts represent the monetary values in their smallest denomination (i.e., cents, øre, pence).
This means that if you are calculating the revenue share in EURO, then
- the From–To ranges,
- the Included Units, and
- the Recorded Units that you submit to us or enter from the front-end MUST all be expressed in CENTS.
That means in case if you are going to use the US dollar (USD) system, then the values must be in cents. If in Danish Krone then the values must in øre and if you will be using British Pounds then the values must be in Pence
| Currency | Smallest Unit |
|---|---|
| Euro | Cents |
| Danish Krone | Øre |
| British Pound | Pence |
10 EURO will be represented as 1000 in the From - To, Included Units and Used Units
Important Note on Currency Precision
The platform supports currencies with up to three decimal places, including:
- BHD (Bahraini Dinar)
- JOD (Jordanian Dinar)
- KWD (Kuwaiti Dinar)
- OMR (Omani Rial)
- TND (Tunisian Dinar)
For currencies with three decimal places, all amounts must be rounded to the nearest ten units of the smallest denomination before use.
Example:
Raw amount: 10,234.254 TND
Rounded: 10,234.25 or 10,234.26
Always round and convert values correctly before reporting or applying them within percentage or percentage-step models.
Ensure that you report the correctly rounded and converted values when using these pricing models.
Percentage-Based Pricing
In this model, the user pays a single percentage of the processed value, based on the applicable value range.
Example:
- €1 – €50,000 → 2.30%
- €50,001 – €150,000 → 1.85%
- €150,001+ → 0.95%
If a customer processes €175,000, the entire amount falls in the €150,001+ range, so the charge is:
0.95% × €175,000 = €1,662.50
Percentage-Step (Graduated Percentage Pricing)
This model applies different rates to each portion of the processed value, rather than a single percentage on the total.
Example:
- €1 – €50,000 → 2.30%
- €50,001 – €150,000 → 1.85%
- €150,001+ → 0.95%
If a customer processes €175,000, the breakdown is:
€50,000 × 2.30% = €1,150
€100,000 × 1.85% = €1,850
€25,000 × 0.95% = €237.50
Total = €3,237.50
By leveraging this endpoint, you can create sophisticated usage-based billing products that accurately reflect your customers' usage patterns and provide fair, transparent pricing across various scenarios.