Get usage details

This document is automatically generated based on https://github.com/authing/authing-docs-factory based on https://api-explorer.genauth.ai V3 API, and is consistent with API parameters and return results. If this document description is incorrect, please refer to V3 API.

Get the current user pool usage details.

Method name

ManagementClient.getUsageInfo

Request parameters

Name	Type	Required	Default value	Description	Sample value

Sample code

import { ManagementClient, Models } from "authing-node-sdk";

// Initialize ManagementClient
const managementClient = new ManagementClient({
  // Need to be replaced with your GenAuth Access Key ID
  accessKeyId: "GEN_AUTH_ACCESS_KEY_ID",
  // Need to be replaced with your GenAuth Access Key Secret
  accessKeySecret: "GEN_AUTH_ACCESS_KEY_SECRET",
  // If you are a privately deployed customer, you need to set the GenAuth service domain name
  // host: 'https://api.your-authing-service.com'
});

(async () => {
  const result = await managementClient.getUsageInfo();

  console.log(JSON.stringify(result, null, 2));
})();

Request response

Type: CostGetCurrentUsageRespDto

Name	Type	Description
statusCode	number	Business status code, which can be used to determine whether the operation is successful, 200 means success.
message	string	Description
apiCode	number	Segmented error code, which can be used to get the specific error type (successful request is not returned). For a detailed list of error codes, see: API Code List
requestId	string	Request ID. Returned when the request fails.
data	<a CurrentUsageRespDto	Response data

Sample result:

{
  "statusCode": 200,
  "message": "Operation successful",
  "requestId": "934108e5-9fbf-4d24-8da1-c330328abd6c",
  "data": {
    "usages": {
      "amount": "0",
      "current": "0",
      "experience": true,
      "modelCode": "SocialConnections",
      "modelName": "SocialConnections: Social account link"
    }
  }
}

Data structure

CurrentUsageRespDto

Name	Type	Is it required	Description	Sample value
usages	array	Yes	Current usage entity Nested type: <a CurrentUsageDto.

CurrentUsageDto

Name	Type	Required	Description	Sample value
amount	string	Yes	Total amount of equity	0
current	string	Yes	Current amount of equity used	0
experience	boolean	yes	Is it a trial benefit?	true
modelCode	string	yes	Benefit code	SocialConnections
modelName	string	yes	Benefit name	SocialConnections: social account links