hiqdev/php-billing

PHP Billing Library

dev-master 2024-11-22 16:04 UTC

Requires

• php: ^8.3
• cache/array-adapter: ^1.2
• hiqdev/php-units: dev-master
• moneyphp/money: ^3.0 | ^4.0
• psr/simple-cache: ^1.0

Requires (Dev)

• ext-intl: *
• behat/behat: ^3.4.3
• cache/array-adapter: *
• hiqdev/hidev: dev-master
• hiqdev/hidev-behat: dev-master
• hiqdev/hidev-hiqdev: dev-master
• hiqdev/hidev-php: dev-master
• hiqdev/php-data-mapper: dev-master
• hoa/ruler: ^2.17
• league/event: ^2.1
• matthiasnoback/behat-expect-exception: ^v0.3.0
• phpunit/phpunit: ^10.0.0
• vimeo/psalm: ^5.0

Suggests

• ext-intl: intl extension is required for formula support
• hiqdev/hoa-compiler: ~1.0
• hiqdev/hoa-file: ~1.0
• hiqdev/hoa-iterator: ~1.0
• hiqdev/hoa-protocol: ~1.0
• hiqdev/hoa-ruler: ~1.0
• hiqdev/hoa-stream: ~1.0
• league/event: required for event-rich billing

BSD-3-Clause

• Andrii Vasyliev
• Dmitry Naumenko
• Andrey Klochok
• Yuriy Myronchuk

• php
• billing
• tariff plan

README

PHP Billing Library

Billing library providing:

• customers with subscriptions

• orders with actions

• tariff plans with prices

• smart discounts with formulas

• bills with charges

• calculator and aggregator

• one-time, metered and recurring charging

Please see additional documentation in russian.

Installation

The preferred way to install this library is through composer.

Either run

php composer.phar require "hiqdev/php-billing"

or add

"hiqdev/php-billing": "*"

to the require section of your composer.json.

Idea

In general the billing functions like this:

For a given order a calculator finds plans and then matches applicable prices to actions and calculates charges. Then charges can be aggregated to bills with aggregator.

Billing operates such ideas:

• Action - customer's metered activity of a certain type at a certain target
• Order - collection of actions
• Bill
• Charge
• Plan
• Price
• Customer
• Sale - a subscription, binding customer to a target and a plan
• Target - object being charged in billing
• Type
• Calculator
• Aggregator

Disclaimer

This billing is designed to be flexible and abstract, so supports different use cases. We use this package in production, wrapping it additional layers, such as:

1. Plan and Price storage and management UI for managers, so they can create plans, fill them with prices and assign to Customers.
2. Actions and Orders producer. This layer takes end-user actions (such as purchasing something) and produces the right Actions inside the Order
3. Persistence layer. This layer implements various RepositoryInterfaces, defined in this package (such as PlanRepositoryInterface, providing data saving and retrieving logic for the required entities.
4. Periodic operations (CRON tasks). This includes meters fetching (such as accumulated resources consumption), transforming them to actions with the right quantity, running billing on them, updating Bills and their Charges.
5. Business metrics monitoring, analysis and alerting. This layer provides regular checks over data, produces by the billing in order to ensure system health.
6. Read API. This API accepts requests, fetches data from the DBMS and implements search with filtering, ordering, access control and more for Orders, Actions, Bills, Prices and so on.

So, as you can see, this package is a concrete foundation of big billing system, but it requires a lot of bricks on top of it to become a fully operable billing. Unfortunately, we do not have all those bricks open-sourced and documented because many of them implement customer-specific logic that cannot be disclosed.

License

This project is released under the terms of the BSD-3-Clause license. Read more here.

Copyright © 2017-2019, HiQDev (http://hiqdev.com/)