Product Usage Management API
REST API
Preview version
This is a new version of this asset.
Overview
Provides a standardized mechanism for usage management, including the creation, update, retrieval, import, and export of a collection of usages. The API manages both rated and non-rated usage. For example, it allows a service provider to (1) retrieve usage generated by a partner service platform for rating purposes and (2) provide rated usage to a partner for consumption follow-up.
Version history
v5.0.0
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.
31-Mar-2026 – TMF635 v5.0.0 Updated coversheet for User Guide and Conformance Profile
17-Mar-2026 – TMF635 v5.0.0 Stable release: Open API Specification (OAS), User Guide, Conformance Profile, Postman Collection, CTK, and Sample implementation code.
03-Mar-2026 – TMF635 v5.0.0 RC3 Preview release: Open API Specification (OAS), User Guide, Conformance Profile, and Postman Collection. Includes a fix addressing ambiguity caused by identical oneOf schemas in the PartyRefOrPartyRoleRef definition. A restriction has been added to the allowed value of @type to improve tooling compatibility without altering the API signatures.
22-Jan-2026 – Usage API v4 uplifted to Product Usage v5, aligning the API and schemas with updated design standards. The /usage endpoint was renamed to /productUsage. serviceUsage and resourceUsage are now handled by separate APIs (TMF727 and TMF771 respectively). Specifications are managed by the TMF767 Product Usage Catalog Management API. A new /exportJob resource was introduced to enable file-based export of product usage data, along with corresponding exportJob events.
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.
07-Nov-2024 – TMF635 CTK file fix: Mac-Linux-RUNCTK.sh modified to remove syntax errors. No impact to awarded Open API Conformance certifications.
API No.
TMF635
Stable version
v5.0
This Version
v4.1
Types
RESTful
DOMAIN
Product
IPR MODE
Apache 2.0 unless stated
Release Date
07 Mar 2024
API assets v4.1
OPEN API SPECIFICATION
API USER GUIDE (RAND)
Components
ODA Components are the software building blocks of a cloud native digital service provider’s network and IT systems, designed for plug-and-play interoperability in a standardized deployment environment (the ODA Canvas). This is a list of ODA Components that expose this API either as a Mandatory or Optional API.
Mandatory
