# List Paid Order Summary - ListPaidOrderSummary

## Overview

Query aggregated completed (paid) order statistics by specified dimensions






## Definition

### Public Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Action**     | string  | Corresponding API command name, the current API is `ListPaidOrderSummary`.                      | **Yes** |
| **PublicKey**  | string  | The user's public key can be obtained from [Console](https://console.sigcalcloud.com/uaccount/api_manage)                                             | **Yes** |
| **Signature**  | string  | User signature generated based on public key and API command, see [Signature Algorithm](/docs/api/summary/signature.md)  | **Yes** |

### Request Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **StartTime** | int | Query start time (Unix timestamp, seconds), required |**Yes**|
| **EndTime** | int | Query end time (Unix timestamp, seconds), required; must be greater than StartTime |**Yes**|
| **ResourceIds.N** | string | Resource ID list (optional) |No|
| **ModelIds.N** | string | Model ID list (optional) |No|
| **PricingUnits.N** | int | Pricing unit list (optional) |No|
| **OrderTypes.N** | int | Order type list (optional) |No|
| **ChargeTypes.N** | int | Charge type list (optional) |No|
| **PricingSkus.N** | string |  Billing unit SKU list (optional) |No|
| **ProductCodes.N** | string | Product code list (optional). Enum: `modelverse`, `sandbox` |No|
| **Regions.N** | string | Region list (optional). See [Region and Zone List](/docs/api/summary/regionlist) |No|
| **OrganizationIds.N** | int | Organization ID list (optional) |No|

### Response Field

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **RetCode** | int | Return status code. If it is 0, it means successful return. If it is not 0, it means failure. |**Yes**|
| **Action** | string | Operation command name. |**Yes**|
| **Message** | string | Returns an error message, providing detailed description when `RetCode` is non-zero. |No|
| **Summaries** | array[[*OrderSummaryItem*](#ordersummaryitem)] | Paid order summary list |**Yes**|

#### Data Model


#### OrderSummaryItem

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **ResourceId** | string | Resource ID |No|
| **PricingSKU** | string | Billing unit SKU |No|
| **ModelID** | string | Model ID |No|
| **ModelName** | string | Model name |No|
| **PricingUnit** | int | Pricing unit (measurement unit) |No|
| **PricingUnitName** | string | Pricing unit name |No|
| **OrderType** | int | Order type  |No|
| **OrderTypeDisplay** | string | Order type display name |No|
| **ChargeType** | int | ChargeType |No|
| **Status** | int | Order status (2=Paid; 3=Cancelled) |No|
| **StatusDisplay** | string | Order status display name |No|
| **ListPrice** | string | <br />List price (original unit price) |No|
| **DiscountPrice** | string | Discounted unit price |No|
| **SumQuantity** | int | Total usage quantity (raw value) |No|
| **SumQuantityDisplay** | string | Total usage display (formatted, K tokens etc. are converted) |No|
| **SumOrderPrice** | string | Total order amount |No|
| **SumOriginalPrice** | string | Total original price |No|
| **SumCashAccount** | string | Total cash account deduction (only returned for paid orders) |No|
| **SumStarCardAccount** | string | Total Star Card deduction amount (only returned for paid orders) |No|
| **SumBonusAccount** | string | Total bonus account deduction (only returned for paid orders) |No|
| **SumCoupon** | string | Total coupon deduction (only returned for paid orders) |No|

## Example

### Request Example
    
```
https://api.sigcalcloud.com/?Action=ListPaidOrderSummary
&Region=cn-zj
&Zone=cn-zj-01
&ProjectId=pRaRcTyR
&ResourceIds=GcNNUFXd
&ModelIds=kZzfEgJH
&PricingUnits=xJSAmIHa
&OrderTypes=oxWOAWBD
&ChargeTypes=jJHlYEWQ
&StartTime=1
&EndTime=rpsXDfTb
&ResourceIds=MBRJGfJr
&ModelIds=HzLyYzfC
&PricingUnits=MvBqNaFn
&OrderTypes=HMrUmfFX
&ChargeTypes=MWUTHbrb
&StartTime=5
&EndTime=7
&ResourceIds.N=GtZdlexq
&ModelIds.N=dufLMhYc
&PricingUnits.N=3
&OrderTypes.N=3
&ChargeTypes.N=3
&StartTime=3
&EndTime=3
&ResourceIds.N=Lthksvru
&ModelIds.N=eQNoCsux
&PricingUnits.N=9
&OrderTypes.N=8
&ChargeTypes.N=7
&StartTime=6
&EndTime=5
&PricingSkus.N=vqcXxipb
&ProductCodes.N=TCBxiHlp
&Regions.N=QwmZlhIn
&OrganizationIds.N=dAhmKEcI
&Regions.N=AaPOmFNz
&OrganizationIds.N=6
```

### Response Example
    
```json
{
  "Action": "ListPaidOrderSummaryResponse",
  "Data": {},
  "RetCode": 0
}
```