---
title: "Get Credit Balance"
method: GET
path: "/api/v1/User/creditbalance"
tags: ["User"]
---

# Get Credit Balance

`GET /api/v1/User/creditbalance`

## Request

- Base URL: `https://api.peakaccount.com`
- URL: `https://api.peakaccount.com/api/v1/User/creditbalance`
- Auth: none declared. Required headers: `Time-Stamp`, `Time-Signature`, `User-Token`, `Client-Token`
- TypeScript: <https://skmtc.dev/peakaccount/apis/peakapis-core/docs/api/v1/User/creditbalance/get.ts> (a function with typed inputs; its response is checked against the schema)

## Headers

- `Time-Stamp` string, required
- `Time-Signature` string, required
- `User-Token` string, required
- `Client-Token` string, required

## Response `200`

Success

- PeakAPIsLibraryModelEcoSystemResponseUserAPICreditBalanceModel
  - `resCode` string
  - `resDesc` string
  - `month` integer
  - `year` integer
  - `endOfMonthDate` string
  - `apiCredit` PeakAPIsLibraryModelEcoSystemResponseUserApiCreditBalanceDetail
    - `freeCredit` number, double
    - `usage` number, double
    - `remainingFreeCredit` number, double
    - `prePaidCredit` number, double
    - `postPaidCredit` number, double
    - `totalRemainingCredit` number, double
    - `isExhausted` boolean
    - `isAvailableForNewTransaction` boolean
  - `importCredit` PeakAPIsLibraryModelEcoSystemResponseUserApiCreditBalanceDetail
    - `freeCredit` number, double
    - `usage` number, double
    - `remainingFreeCredit` number, double
    - `prePaidCredit` number, double
    - `postPaidCredit` number, double
    - `totalRemainingCredit` number, double
    - `isExhausted` boolean
    - `isAvailableForNewTransaction` boolean

## Changes

- **2026-11-03** `433c913c750f`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/peakaccount/apis/peakapis-core/changes/api/v1/User/creditbalance/get.md)

---

[API](https://skmtc.dev/peakaccount/apis/peakapis-core.md) - [All operations](https://skmtc.dev/peakaccount/apis/peakapis-core/llms.txt) - [OpenAPI document](https://skmtc.dev/peakaccount/apis/peakapis-core/revisions/433c913c750f?raw)