https://github.com/openbankproject/obp-billing
For billing for OBP API usage. OBP Billing is used in conjunction with OBP APIs and Invoice Ninja APIs to generate invoices and throttle non-paying Consumers
https://github.com/openbankproject/obp-billing
Last synced: over 1 year ago
JSON representation
For billing for OBP API usage. OBP Billing is used in conjunction with OBP APIs and Invoice Ninja APIs to generate invoices and throttle non-paying Consumers
- Host: GitHub
- URL: https://github.com/openbankproject/obp-billing
- Owner: OpenBankProject
- License: agpl-3.0
- Created: 2020-02-13T17:01:00.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-07-09T22:02:27.000Z (almost 5 years ago)
- Last Synced: 2025-01-16T07:57:14.905Z (over 1 year ago)
- Homepage:
- Size: 44.9 KB
- Stars: 2
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# OBP-Billing
A solution for the Billing / Monetisation of API usage
API Monetisation in OBP is realised using five components:
(1) The *OBP API* itself logs, stores and provides APIs for API usage (API Metrics).
Also OBP provides APIs to read and set Consumer Rate Limiting.
(2) The *OBP Billing App* (this Application) generates Clients and Invoices in the (3) *REST based Accounting* system (e.g. Invoice Ninja) based on the API usage of each Consumer and can decide to limit the Consumer via the OBP Rate Limiting APIs if bills are not settled.
The accounting system sends invoices to the (4) *API Consumer* (TPP Application) for the usage of the OBP API.
API Consumer makes the payment using the (5) *Payment System* (e.g. Stripe) which is connected to the Invoice system and which sends information back to the Accounting system about records of payments.
Periodically, the OBP Billing App queries the Accounting system API and blocks API overdue Consumers via the OBP Rate Limiting and Consumer APIs.
