billing-service/README.md
2026-04-23 15:59:41 +08:00

29 lines
1.1 KiB
Markdown

# billing-service
`billing-service` is the v1 minute-delta and replay-safe writer for the Cloud
Network Billing & Control Plane.
It pulls windowed normalized snapshots from one or more `xray-exporter`
sources, computes deltas from cumulative counters, and writes idempotent usage
and billing facts into the existing `accounts.svc.plus` PostgreSQL schema.
## Endpoints
- `GET /api/ping`
- `POST /v1/jobs/collect-and-rate`
- `POST /v1/jobs/reconcile`
- `GET /healthz`
- `GET /v1/status`
## Documentation
- `docs/design.md` - current implementation design, main collect-and-rate flow,
idempotency rules, and module boundaries
- `docs/reference/` - code-level reference for `cmd/` and `internal/`
packages, including types, interfaces, and functions
- `docs/README.md` - documentation index and verification notes
- `docs/architecture.md` - deployment and data-flow diagrams
- `docs/api.md` - task API surface and upstream/downstream boundaries
- `sql/billing-service-schema.sql` - bootstrap/reference DDL aligned with the
current `accounts.svc.plus` accounting schema