# NEUserBalance

**negdkcc**

***

negdkcc / NEUserBalance

## Type Alias: NEUserBalance

> **NEUserBalance** = `object`

Defined in: [data/NEUserBalance.ts:5](https://github.com/EternalsGame/universal-sdk/blob/7b1076b6b36dd7c5b65f4a2f518d40773314a555/gdk/cocos-creator/assets/negdk/scripts/data/NEUserBalance.ts#L5)

Represents the user's balance and currency information.
\
This type tracks the available, total, and frozen amounts of currency.

### Properties

#### available

> **available**: `number`

Defined in: [data/NEUserBalance.ts:14](https://github.com/EternalsGame/universal-sdk/blob/7b1076b6b36dd7c5b65f4a2f518d40773314a555/gdk/cocos-creator/assets/negdk/scripts/data/NEUserBalance.ts#L14)

The available amount of currency the user can use.

***

#### balance

> **balance**: `number`

Defined in: [data/NEUserBalance.ts:19](https://github.com/EternalsGame/universal-sdk/blob/7b1076b6b36dd7c5b65f4a2f518d40773314a555/gdk/cocos-creator/assets/negdk/scripts/data/NEUserBalance.ts#L19)

The total balance of currency, including frozen amounts.

***

#### currency

> **currency**: `string`

Defined in: [data/NEUserBalance.ts:9](https://github.com/EternalsGame/universal-sdk/blob/7b1076b6b36dd7c5b65f4a2f518d40773314a555/gdk/cocos-creator/assets/negdk/scripts/data/NEUserBalance.ts#L9)

The type of currency (e.g., "SPACE\_STONE").

***

#### frozen

> **frozen**: `number`

Defined in: [data/NEUserBalance.ts:24](https://github.com/EternalsGame/universal-sdk/blob/7b1076b6b36dd7c5b65f4a2f518d40773314a555/gdk/cocos-creator/assets/negdk/scripts/data/NEUserBalance.ts#L24)

The amount of currency that is frozen and cannot be used.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.eternals.game/gdk-documentation/cocos-creator/api-reference/ninetyeight-game-development-kit-cocos-creator/type-aliases/neuserbalance.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.