# List Unpaid Orders - ListUnpaidOrders

## Overview

Query detailed list of current outstanding (unpaid) orders






## Definition

### Public Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Action**     | string  | Corresponding API command name, the current API is `ListUnpaidOrders`.                      | **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 |
|:---|:---|:---|:---|
| **EndTime** | int | Query end time (Unix timestamp, seconds). Must be provided together with `StartTime` |**Yes**|
| **StartTime** | int | Query start time (Unix timestamp, seconds). When provided with `EndTime`, enables custom time range query; EndTime must be greater than StartTime |**Yes**|
| **PageSize** | int | Page size (min 10, max 100) |**Yes**|
| **Page** | int | Page number, starting from 1 |**Yes**|
| **ResourceIds.N** | string | API Key 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|
| **Regions.N** | string | Region list (optional). See [Region and Zone List](/docs/api/summary/regionlist) |No|
| **PricingSkus.N** | string | Billing SKU list (optional) |No|
| **ProductCodes.N** | string | Product code list (optional). Enum: `modelverse`, `sandbox` |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|
| **Orders** | array[[*UnpaidOrderItem*](#unpaidorderitem)] | Unpaid order detail list |**Yes**|

#### Data Model


#### UnpaidOrderItem

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Region** | string | Region code |No|
| **OrderNo** | string | Order number |No|
| **SourceOrderNo** | string | Source order number (original order that generated the debt) |No|
| **CompanyID** | int | Company ID |No|
| **OrganizationID** | int | Organization ID |No|
| **OrganizationName** | string | Organization name |No|
| **UserEmail** | string | User email |No|
| **ChargeType** | int | Charge type |No|
| **ChargeTypeDisplay** | string | Charge type display name |No|
| **Channel** | int | Channel |No|
| **Currency** | string | Currency (e.g., CNY, USD) |No|
| **CurrencyDisplay** | string | Currency display name  |No|
| **ResourceID** | string | Resource ID |No|
| **ResourceType** | int | Resource type |No|
| **ResourceTypeDisplay** | string | Resource type display name |No|
| **ModelID** | string | Model ID |No|
| **ModelName** | string | Model name |No|
| **OrderType** | int | Order type |No|
| **OrderTypeDisplay** | string | Order type display name |No|
| **PricingSKU** | string | Billing unit (SKU) name |No|
| **Quantity** | int | Usage quantity |No|
| **QuantityDisplay** | string | Usage display (with unit) |No|
| **PricingUnit** | int | Pricing unit (measurement unit) |No|
| **PricingUnitDisplay** | string | Pricing unit display name (e.g., K Tokens, Image, Second) |No|
| **ListPrice** | string | List price (original unit price) |No|
| **DiscountPrice** | string | Discounted unit price |No|
| **OrderTotalPrice** | string | Order total amount |No|
| **OriginalPrice** | string | Original price |No|
| **Status** | int | Order status |No|
| **StatusDisplay** | string | Order status display name |No|
| **CreateTime** | string | Create time (Unix timestamp, seconds) |No|
| **StartTime** | int | Start billing time (Unix timestamp, seconds) |No|
| **EndTime** | int | End billing time (Unix timestamp, seconds) |No|
| **PaidTime** | int | Payment completion time (Unix timestamp, seconds) |No|
| **RevocationTime** | string | Revocation time (Unix timestamp, seconds) |No|
| **RegionDisplay** | string | Region display name |No|
| **ProductCode** | string | Product code |No|
| **ProductCodeDisplay** | string | Product code display name |No|

## Example

### Request Example
    
```
https://api.sigcalcloud.com/?Action=ListUnpaidOrders
&Region=cn-zj
&Zone=cn-zj-01
&ProjectId=zqPPMqBX
&Page=8
&PageSize=5
&ResourceIds.N=KrvxcKCz
&ModelIds.N=jYCYycUM
&PricingUnits.N=8
&OrderTypes.N=6
&StartTime=4
&EndTime=9
&Regions.N=hyVxsESW
&PricingSkus.N=smcMOmBi
&ProductCodes.N=zZgIeVcp
```

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