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.

What is the Base Plan?

The Base Plan represents the primary, foundational offering that a customer subscribes to. In the Billspree catalog, there are two types of plans:
  1. Base Plans: The primary offerings that can be subscribed to. A Base Plan can also include Add-On Plans to expand its scope, features, or quotas.
  2. Add-On Plans: Optional plans that attach to a Base Plan. Crucially, Add-On Plans are final packages and cannot have any other Add-On Plans nested inside them.
While both plan types are supported in Billspree to compose flexible offerings, this document focuses strictly on configuring and managing Base Plans. The Base Plan brings together your system components in order:
  • Define your Pricing Template (e.g., “water supply”, “electricity”, “internet”). It is a prerequisite of the Base Plan.
  • Set prices (Rate Lists) and rules (Rating Rules Sets) for how to calculate the bill.
  • Set taxes and discounts that apply to bills.

Pricing Template Setup

1- Setup Pricing Template first.
Screenshot 2026 02 19 At 11 14 04 AM
Setup Pricing Template →

Base Plan Setup

  1. Click on the Plan Variants tab
Screenshot 2026 02 19 At 11 14 50 AM
  1. Click on Add Plan Variant
Screenshot 2026 02 19 At 1 05 55 PM
  1. Your Pricing Template values and components show here in the Base Plan as tabs
Screenshot 2026 02 19 At 11 19 09 AM
  1. Give your rates in Values
Screenshot 2026 02 19 At 11 20 16 AM
Component
  1. Click each component tab, and add your formulas for all components.
You see all your components here in tabs. While making a billing rule, you can pass the previous components as a parameter
Screenshot 2026 02 20 At 2 18 15 PM
Screenshot 2026 02 19 At 1 10 40 PM

Rule

The rule is basically a combination of Condition and Billing Formula

Conditions

We have conditions in the Base Plan for each component. We have multiple conditions
Screenshot 2026 02 20 At 2 03 54 PM

Formula

We have a formula in the Base Plan for each component. One formula for multiple 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

Test Plan

Test Plan lets you run the Base Plan with sample inputs and see each component’s result, before it is used in live billing.
  1. Open the Plan screen for the Base Plan you want to check.
Screenshot From 2026 04 20 18 29 14
  1. Click Test in the plan header (with Update, Discard, and Export).
Screenshot From 2026 04 20 18 29 54
  1. Enter sample values for your date, components and usage inputs (and any other fields your package defines).
Screenshot From 2026 04 20 18 31 20
  1. Click Process to calculate the bill for those inputs.
  2. Read Outputs: you see each billing component with the amount your conditions and formula produced.
Screenshot From 2026 04 20 18 32 19
  1. Click Publish when you want a PDF bill for that same test run. The app uses a bill template from your pricing template. If no template is available, fix the template on the pricing template, then try again. When publish succeeds, the PDF opens in the browser.
Screenshot From 2026 04 20 18 35 37
Run Test Plan again after you change values, conditions, or formulas, so you can confirm totals are correct.

Prepaid

Prepaid means you pay first, then use.
  • You select the Base Plan that you want, then subscribe to it.
  • Pay for it.
  • Then you use the service (calls, data, electricity, etc.)
  • When the balance is low or finished, subscribe again.
So: pay → then use (from the balance you already paid).

Postpaid

Postpaid means you use first, pay later.
  • You use the service (calls, data, electricity, etc.) during the month.
  • At the end of the period (e.g. month), the company sends you a bill for what you used.
  • You pay that bill by the due date.
So: use → get bill → then pay.

Tracking Usage

There are two primary methods to record usage for a subscription:

During Subscription Creation

When creating a new subscription, the amount is deducted, and an invoice is generated and sent to the customer.

Via API

You can record usage data programmatically at any time using the Billspree API. The system stores all recorded usage events and accumulates them for the next billing cycle.