Usage Consumption Management API

Overview

This API provides the real-time value within buckets (SMS, Voice, Data, TV for example) that a customer consumes with each of their devices, related to subscribed communication products without having to wait for the bill cycle. A usage report retrieves the data related to these balances.

Version history

v5.1

08-May-2026 docker-compose has been expanded to enable proxy settings by default, simplifying CTK execution in corporate HTTP proxy environments where this previously required in‑house configuration. README files have been updated to document proxy usage. Failed HTML reports can now be opened directly in a browser, and HTML reports now include headers identifying the API and CTK version used, improving certification clarity and traceability.

22-Apr-2026 - Usage Consumption API v5.1.0 Stable release: Open API Specification (OAS), User Guide, Conformance Profile, Postman Collection, CTK and RI. This API to bring in line with current schemas and facilitate an updated CTK build.

08-Apr-2026 – TMF677 v5.1 Preview release: Open API Specification (OAS), User Guide, Conformance Profile, and Postman Collection

Update: Refresh of TMF677 Usage Consumption API to bring in line with current schemas and facilitate an updated CTK build

v5.0

4-September-2025 v5.0 stable release: OAS, User Guide, Conformance profile, CTK, VS, and Postman.

18 July 2025 TMF677 preview release v5.0.0: Conformance Profile

09 Jan 2025 preview release v5.0: Open API Specification (OAS), user guide

v4.0.0

15-May-2026 – CTK updated docker-compose has been expanded to enable proxy settings by default, simplifying CTK execution in corporate HTTP proxy environments. README files have been updated to document proxy configuration.

01 Jul 2021 v4.0 stable release: OAS, user guide, conformance profile, CTK, RI and postman