- Development Integration
- /
- SDK
- /
- Python
- /
Management Module
- /
管理计量计费
- /
- 获取订单列表
¶ Get order list
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 the description of this document is incorrect, please refer to V3 API.
Get the current user pool order list
¶ Method name
ManagementClient.get_orders
¶ Request parameters
| Name | Type | Is it required? | Default value | Description | Sample value |
|---|---|---|---|---|---|
| page | number | No | 1 | Current page number, starting from 1 | 1 |
| limit | number | No | 10 | Number per page, maximum cannot exceed 50, default is 10 | 10 |
¶ Request Response
Type: CostGetOrdersRespDto
| 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 (no return for successful requests). For a detailed list of error codes, please see: API Code List (opens new window) |
| requestId | string | Request ID. Returned when the request fails. |
| data | GetOrdersRes | Response data |
Example results:
{
"statusCode": 200,
"message": "Success",
"requestId": "934108e5-9fbf-4d24-8da1-c330328abd6c",
"data": {
"list": {
"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
¶ GetOrdersRes
| Name | Type | Is it required? | Description | Sample value |
|---|---|---|---|---|
| totalCount | string | yes | Total | |
| list | array | yes | Response data Nested type: OrderItem. |
¶ OrderItem
| Name | Type | Is it required? | Description | Sample 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: Cancelled, 5: Expired |
| orderType | string | Yes | Order type | New: New purchase, Upgrade: Upgrade, Renew: Renewal, Overdue_Correct: Overdue correction, Overflowed_Correct: Overflowed correction |
| createTime | string | Yes | Creation time | |
| source | string | Yes | Licence: License order, Offline: Offline transaction, Eadmin: Backstage activation, SelfHelp: Self-service order, Cdkey: Cdkey activity redemption |