- Development Integration
- /
- SDK
- /
- Java
- /
Management module
- /
Manage metering and billing
- /
- Get usage details
¶ Get usage details
Update time: 2025-07-23 07:34:21
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 | Is it required | Default Value | Description | Example Value |
|---|
¶ Sample Code
package test.management;
import cn.authing.sdk.java.client.ManagementClient;
import cn.authing.sdk.java.dto.CostGetCurrentUsageRespDto;
import cn.authing.sdk.java.model.ManagementClientOptions;
import cn.authing.sdk.java.util.JsonUtils;
public class GetUsageInfoTest {
// Need to be replaced with your GenAuth Access Key ID
private static final String ACCESS_KEY_ID = "AUTHING_ACCESS_KEY_ID";
// Need to be replaced with your GenAuth Access Key Secret
private static final String ACCESS_KEY_SECRET = "AUTHING_ACCESS_KEY_SECRET";
public static void main(String[] args) throws Throwable {
ManagementClientOptions clientOptions = new ManagementClientOptions();
clientOptions.setAccessKeyId(ACCESS_KEY_ID);
clientOptions.setAccessKeySecret(ACCESS_KEY_SECRET);
// If you are a private deployment customer, you need to set the GenAuth service domain name
// clientOptions.setHost("https://api.your-authing-service.com");
ManagementClient client = new ManagementClient(clientOptions);
CostGetCurrentUsageRespDto usageInfo = client.getUsageInfo();
System.out.println(JsonUtils.serialize(usageInfo));
}
}
¶ 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 requests are not returned). For a detailed list of error codes, see: API Code List (opens new window) |
| requestId | string | Request ID. Returned when the request fails. |
| data | CurrentUsageRespDto | Response data |
Example Results:
{
"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 links"
}
}
}
¶ Data Structure
¶ CurrentUsageRespDto
| Name | Type | Is it required | Description | Example Value |
|---|---|---|---|---|
| usages | array | yes | Current usage entity Nested Type: CurrentUsageDto. |
¶ CurrentUsageDto
| Name | Type | Is it required | Description | Example Value |
|---|---|---|---|---|
| amount | string | yes | Total equity | 0 |
| current | string | yes | Current equity usage | 0 |
| experience | boolean | yes | Is it a trial period equity | true |
| modelCode | string | yes | Equity code | SocialConnections |
| modelName | string | yes | Equity Name | SocialConnections: Social account links |
