1. Development Integration
  2. /
  3. SDK
  4. /
  5. Python
  6. /

  7. Management Module

  8. /

  9. 管理计量计费

  10. /
  11. 获取用量详情

Get usage details

Update time: 2025-07-23 07:34:21
Edit

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

NameType
Required
Default value
Description
Sample value

Request Response

Type: CostGetCurrentUsageRespDto

NameTypeDescription
statusCodenumberBusiness status code, which can be used to determine whether the operation is successful. 200 means success.
messagestringdescription
apiCodenumberSegmented 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 (opens new window)
requestIdstringRequest ID. Returned when the request fails.
dataCurrentUsageRespDtoResponse data

Example results:

{
  "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

NameType
Is it required
Description
Sample value
usagesarrayYesCurrent usage entity Nested type: CurrentUsageDto.

CurrentUsageDto

NameType
Is it required?
Description
Sample value
amountstringYesTotal equity0
currentstringYesCurrent equity usage0
experiencebooleanYesIs it a trial equity?true
modelCodestringYesEquity codeSocialConnections
modelNamestringYesEquity nameSocialConnections: social account links