Managing Modules
This guide is specific to the Modules Tab on the Admin Dashboard. It's helpful if you:
- Have questions about a module.
- Are unable to see a specific module's usage on the dashboard.
- Need a quick guide for Module Owners to add new modules.
For how modules relate to clients (authorization, pricing), see Linking modules to a client in the Admin Dashboard Guide.
Terminology
| Term | Meaning |
|---|---|
| Module Name | The name or identifier of the module, as displayed on Dashboards and Invoices. |
| Sub-Module Name | If the module has multiple sub-modules, the name identifying each individual component. |
| Billing Unit | The unit of measurement used for billing — how usage is tracked (e.g., Per Check, Per API call). |
| Module Owner | The SPOC responsible for managing and overseeing the module (typically from the product team). |
| Description | A brief internal summary providing more context about the module's purpose and functionality. |
| Unit ID | The unit logged by the API to the Billing DB. |
| Linked Units | A set of Unit IDs whose usage is combined and displayed under this module. |
| Billable Status Codes | Status codes that are considered for billing. |
| API Endpoints | Endpoint(s) associated with the module (auto-fetched, not manually entered). |
| Added on | Date of creation of the module on the Admin Dashboard. |
Adding new modules (Module Owners)
Only Module Owners have the ability to add new modules. Module Owners are typically from the product team.
Before adding, refer to the Terminology section above for details on all required fields.
Determining the Unit ID
- For Thomas APIs: the Unit ID is typically the name of the API. For example, if the endpoint is
/v1/faceAuth, the logged Unit ID will befaceAuth. - For non-Thomas APIs: the engineering team (API creator) can help determine what data is logged to the Billing DB and how the Unit ID is assigned as part of
req.headers.module.
Multiple units for the same module
If there are multiple units associated with the same module, reach out to the Billing Team for assistance in setting up Linked Units. This configuration cannot be done directly through the Dashboard.
Updating existing modules (Module Owners)
What's possible via the Admin Dashboard
- Transferring ownership of a module
- Editing the Module Name and Sub-Module Name
- Editing the Description of a module
These edits do not impact any billing calculations.
What's not possible via the Admin Dashboard
- Editing the Unit ID or Linked Units for a module
- Editing the Billable Status Codes
These fields have a direct impact on billing calculations and cannot be updated self-serve. Contact the Billing Team for any assistance.
FAQs
I'm unable to find usage for a particular API that my client is using. What are the next steps?
Reach out to the Modules Team to identify the owner of the module. They can add the module to the Admin Dashboard.
I've added a module today but cannot see its usage for my client. Why?
Usage data for all clients is updated at 8 AM IST every day. Come back tomorrow to view the usage.
I'm unable to add the module through the Admin Dashboard. How should I proceed?
Share all the module details (Module Name, Sub-Module Name, Description, Unit ID, Billable Status Codes) with the Billing Team, along with a screenshot of the error.
Who decides the Billable Status Codes for a module? Can it vary from client to client?
The Module Owner is responsible for all the details of a module. Billable Status Codes cannot differ between clients.