# Get Billing Overview - ListUBillOverview

## Overview

Bill Overview. You can obtain an overview of the bill for a certain billing period based on product/project/user dimensions.

 > 💡 The monthly bill overview generally has a one-day delay




## Definition

### Public Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Action**     | string  | Corresponding API command name, the current API is `ListUBillOverview`.                      | **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 |
|:---|:---|:---|:---|
| **BillingCycle** | string | Billing period, in the format of YYYY-MM, for example, 2022-02, only supports queries after 2018-05. |**Yes**|
| **Dimension** | string | Billing dimensions, product aggregated by product, project aggregated by project, user aggregated by sub-account |**Yes**|
| **HideUnpaid** | int | Whether to display the billed invoices, 1 for billed, 0 for pending (default 0) |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|
| **TotalCount** | int | Total Number of Billing Overview Data |**Yes**|
| **TotalPaidAmount** | string | Total Amount of Orders Accounted (Displayed when Accounted) |No|
| **TotalPaidAmountReal** | string | Total Amount Deducted from Cash Account (Displayed when Credited) |No|
| **TotalUnpaidAmount** | string | Total amount of pending orders (displayed when pending) |No|
| **Items** | array[[*BillOverviewItem*](#billoverviewitem)] | Bill Aggregation Data |**Yes**|

#### Data Model


#### BillOverviewItem

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Dimension** | string | Billing Dimension, product aggregated by product dimension, project aggregated by project dimension, user aggregated by sub-account dimension |**Yes**|
| **Amount** | string | Total Order Amount |**Yes**|
| **AmountCoupon** | string | Voucher Deduction (Displayed when credited) |No|
| **AmountFree** | string | Deductible gifted amount (displayed when credited) |No|
| **AmountReal** | string | Cash Account Payment (Displayed when credited) |No|
| **ProductCategory** | string | Product Category (Displayed when filtering by product in bill dimension) |No|
| **ResourceType** | string | Product Type (Displayed when filtering by product in the billing dimension) |No|
| **ResourceTypeCode** | int | Product Type Code (displayed when filtering by product in billing dimension) |No|
| **ProjectName** | string | Project Name (Displayed when filtering by project in billing dimension) |No|
| **UserEmail** | string | Account Email (Displayed when filtering by sub-account in billing dimension) |No|
| **UserName** | string | Account Name (Displayed when filtering by sub-account in bill dimension) |No|
| **UserDisplayName** | string | Account Nickname (displayed when filtering by sub-account in billing dimension) |No|
| **Admin** | int | Is this account the main account? 1 for main account, 0 for sub-account (displayed when filtering by sub-account in billing dimension). |No|

## Example

### Request Example
    
```
https://api.sigcalcloud.com/?Action=ListUBillOverview
&BillingCycle=2022-01
&Dimension=product
&HideUnpaid=0
```

### Response Example
    
```json
{
  "Action": "ListUBillOverviewResponse",
  "Items": [
    {
      "Amount": "401.76",
      "Dimension": "product",
      "ProductCategory": "storage",
      "ResourceType": "ufs",
      "ResourceTypeCode": 112
    },
    {
      "Amount": "133.92",
      "Dimension": "product",
      "ProductCategory": "compute",
      "ResourceType": "USNAPSHOT",
      "ResourceTypeCode": 283
    }
  ],
  "RetCode": 0,
  "TotalCount": 2,
  "TotalUnpaidAmount": "535.68"
}
```