---
title: "Get account details and current balance"
method: GET
path: "/customer"
tags: ["Customer"]
---

# Get account details and current balance

`GET /customer`

## Request

- Base URL: `https://api.commpeak.com/portal`
- URL: `https://api.commpeak.com/portal/customer`
- Auth: API key in header `Authorization`

Gets the account email, available balance and temporary credit of the customer owning the token; `balance` is in USD and excludes `temporary_credit`. SMS-enabled accounts also get `sms_balance`, `sms_currency` and `sms_platform` (null when no SMS platform is activated). Responds 503 when the billing system is temporarily unavailable; retry later

## Response `200`

Successful Response

- CustomerResponse: Customer info envelope returned by `GET /portal/customer`. The actual payload is `{customer: {...}}`.
  - `customer` CustomerInfo, required: Customer profile + balances (the body of `CustomerResponse.customer`).
    - `email` string, required: Account's primary email address.
    - `balance` number, required: Available account balance in USD, excluding temporary credit. May be negative when the account is in debt.
    - `temporary_credit` number, required: Total amount of temporary credit currently granted to the account and not yet closed, in USD.
    - `sms_balance` number, nullable: Balance available for sending SMS. SMS is funded from the account balance. Present only when SMS service is enabled.
    - `sms_currency` string, nullable: Currency of the SMS account (e.g. USD). Present only when SMS service is enabled.
    - `sms_platform` integer, nullable: Tenant number of the activated SMS platform, or null when no SMS platform is activated.

---

[API](https://skmtc.dev/commpeak/apis/commpeak-portal-api.md) - [All operations](https://skmtc.dev/commpeak/apis/commpeak-portal-api/llms.txt) - [OpenAPI document](https://skmtc.dev/commpeak/apis/commpeak-portal-api/revisions/df57b0c16367?raw)