Skip to main content

Documentation Index

Fetch the complete documentation index at: https://spreesuite.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

1. The Big Picture: What is a Parameterized Rating Rules Set?

While a Pricing Template establishes the structural layout and a Rate List supplies the concrete currency prices, the Parameterized Rating Rules Set is the billing engine’s logical brain. It defines the exact calculations, tax rates, volume multipliers, and regional discounts applied to customer billing metrics. A Parameterized Rating Rules Set is created directly from a Pricing Template. After setting up your Pricing Template, you define a Plan within it. If you configure only the formulas and conditions (and leave the raw values tab blank) and mark that plan as Abstract, it instantly becomes a Parameterized Rating Rules Set (or Rating Rules Set). By marking the Plan as Abstract, the system makes it unsubscribeable—meaning customers cannot subscribe to it directly. Instead, it serves as a reusable master logic card that other concrete, sellable plans inherit or reference.

2. The Core Mechanics of a Rule

A billing rule in Billspree is composed of two primary pillars:

2.1. Conditions (Filters)

Conditions are logical gates that determine when a formula should run. They filter calculations based on customer attributes or subscription properties. You can configure multiple sequential conditions for a single component.
  • Examples:
    • IF Subscription SLA == "Gold"
    • IF Customer Region == "Europe"

2.2. Billing Formulas (Computations)

Formulas define the actual math used to compute the line item total when its corresponding conditions are satisfied. Billspree supports one unified billing formula for multiple matching conditions.
  • Example: Base Rate * 0.90 (calculating a 10% partner discount).

2.3. Component Chaining (Operator Advantage)

To build progressive tax structures, surcharges, or composite discounts, Billspree allows you to perform Component Chaining. While designing a billing rule for a component, you can reference previously calculated components as dynamic variables in your formulas!
  • Example: Creating a “VAT Tax Charges” component that evaluates (Base Charges + Electricity Consumption Charges) * 0.15.

3. Step-by-Step Configuration Guide

Step 1: Set Up the Pricing Template First

A Pricing Template is the strict prerequisite. Ensure your master placeholders, properties, and usage inputs are configured first:
Screenshot 2026 02 19 At 11 14 04 AM
Setup Pricing Template →

Step 2: Navigate to Plans tab

Open your Billspree dashboard, navigate to the catalog builder, and click on the Plan Variants tab:
Screenshot 2026 02 19 At 11 14 50 AM

Step 3: Create a New Plan

Click the Add Plan Variant button to open the workspace. Here, define the logical catalog name (e.g., SaaS Advanced Enterprise Rules), its Code, and Description:
Screenshot 2026 02 19 At 1 05 55 PM

Step 4: Configure Conditions & Formulas for Components

Your defined components will display as tabs in your workspace. Click on each calculated component tab to configure its conditions and formulas. To chain calculations, you can select and pass previously computed components as formula parameters from the checklist:
Screenshot 2026 02 20 At 2 18 15 PM
Screenshot 2026 02 19 At 1 10 40 PM
Configure the multiple Conditions for your specific charge list calculations:
Screenshot 2026 02 20 At 2 03 54 PM
Input the Formulas corresponding to those conditions:
Screenshot 2026 02 20 At 2 01 49 PM
Screenshot 2026 02 20 At 1 55 23 PM
Screenshot 2026 02 20 At 2 00 53 PM

Step 5: Mark the Plan as Abstract (Creating the Rating Rules Set)

Once you are done writing your billing rules (and leaving the rawValues rate cards blank), mark the plan as Abstract and save it. By setting the plan to abstract, the system saves it not as a concrete sellable package (making it unsubscribeable), but as a reusable, master logical Parameterized Rating Rules Set!