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.get_usage_info

Request parameters

Name	Type	Required	Default value	Description	Sample value

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 (not returned for successful requests). 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": "Success",
  "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	Is it required?	Description	Sample value
amount	string	Yes	Total equity	0
current	string	Yes	Current equity usage	0
experience	boolean	Yes	Is it a trial equity?	true
modelCode	string	Yes	Equity code	SocialConnections
modelName	string	Yes	Equity name	SocialConnections: social account links