- Development Integration
- /
- SDK
- /
- Java
- /
Management module
- /
Manage metering and billing
- /
- Get order details
¶ Get order 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 order details
¶ Method Name
ManagementClient.getOrderDetail
¶ Request Parameters
| Name | Type | Is it required | Default Value | Description | Example Value |
|---|---|---|---|---|---|
| orderNo | string | yes | - | Order Number | 2022080410062060e26f7fd6b9 |
¶ Sample Code
package test.management;
import cn.authing.sdk.java.client.ManagementClient;
import cn.authing.sdk.java.dto.CostGetCurrentUsageRespDto;
import cn.authing.sdk.java.dto.CostGetOrderDetailRespDto;
import cn.authing.sdk.java.dto.GetOrderDetailDto;
import cn.authing.sdk.java.model.ManagementClientOptions;
import cn.authing.sdk.java.util.JsonUtils;
public class GetOrderDetailTest {
// 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);
GetOrderDetailDto getOrderDetailDto = new GetOrderDetailDto();
getOrderDetailDto.setOrderNo("AUTHING_ORDER_NO");
CostGetOrderDetailRespDto orderDetail = client.getOrderDetail(getOrderDetailDto);
System.out.println(JsonUtils.serialize(orderDetail));
}
}
¶ Request Response
Type: CostGetOrderDetailRespDto
| Name | Type | Description |
|---|---|---|
| statusCode | number | Business status code. You can use this status code to determine whether the operation is successful. 200 means success. |
| message | string | Description |
| apiCode | number | Segment error code, through which the specific error type can be obtained (not returned for successful requests). For a detailed list of error codes, see:API Code List (opens new window) |
| requestId | string | Request ID. Returned when the request fails. |
| data | OrderItem | Response data |
Example Results:
{
"statusCode": 200,
"message": "Operation successful",
"requestId": "934108e5-9fbf-4d24-8da1-c330328abd6c",
"data": {
"orderNo": "202209251234224",
"status": "1: Unpaid, 2: Paid, 3: Completed, 4: Cancelled, 5: Expired",
"orderType": "New: New purchase, Upgrade: Upgrade, Renew: Renew, Overdue_Correct: Overdue correction, Overflowed_Correct: Overdue correction"
}
}
¶ Data Structure
¶ OrderItem
| Name | Type | Is it required | Description | Example Value |
|---|---|---|---|---|
| orderNo | string | yes | order number | 202209251234224 |
| goodsName | string | yes | package name in Chinese | |
| goodsNameEn | string | yes | package name in English | |
| goodsUnitPrice | string | yes | unit price | |
| quantity | string | yes | quantity | |
| actualAmount | string | yes | actual amount | |
| status | string | yes | order status | 1: unpaid, 2: paid, 3: completed, 4: canceled, 5: expired |
| orderType | string | yes | order type | New: new purchase, Upgrade: upgrade, Renew: renewal, Overdue_Correct: overdue correction, Overflowed_Correct: overdue correction |
| createTime | string | yes | creation time | |
| source | string | yes | Licence: license Order, Offline: offline transaction, Eadmin: backend activation, SelfHelp: self-service order, Cdkey: Cdkey activity redemption |
