Broadleaf Microservices
  • v1.0.0-latest-prod

Billing Services

Table of Contents
Important

Requirement: An extended commercial license is required to obtain, deploy, and utilize this functionality.

If you intend to use these services, please contact your Broadleaf representative to discuss licensing details and access rights.

Overview

BillingServices provides the financial system of record for subscriptions. It coordinates with PaymentTransactionServices to process recurring payments for a subscription. Naturally, a tax integration can be set up to include taxes in the recurring transactions.

While initial subscription sign-ups and modifications (like upgrades, downgrades, and edits) are orchestrated by the Subscription Operation Services and often involve an immediate checkout charge, those operations also generate `BillingEvent`s in the Billing Service. The Billing Service’s scheduled jobs process these generated events alongside regular recurring subscription charges.

A subscription can be upgraded or downgraded with natural continuity, tying the subsequent subscription to the previous one. Once the upgrade date is reached (e.g. next renewal date), the preempted subscription will then be cancelled.

A customer can also cancel a subscription by themselves. This action will propagate across the system and prevent it from being billed in the future. This service can also process a refund in cases when it is configured to do so.

For a conceptual overview of the entire subscription ecosystem, see Subscriptions Ecosystem.

Key Pages