---
title: "Own balance (end-user)"
method: GET
path: "/credits/me/balance"
tags: ["Widget"]
---

# Own balance (end-user)

`GET /credits/me/balance`

## Request

- Base URL: `https://api.paywithlocus.com/api`
- URL: `https://api.paywithlocus.com/api/credits/me/balance`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer and API key in header `X-Locus-Publishable-Key`

Returns the calling end user's own balance in the workspace's credit denomination. Authenticates with an end-user token, optionally alongside a publishable key for the browser widget.

## Headers

- `X-Locus-Session-Id` string

## Response `200`

Balance in the tenant's credit denomination

- object
  - `success` unknown, required
  - `balance` object, required
    - `externalUserId` string, required: Case-sensitive immutable ID in the tenant namespace. Prefer an identity-provider subject, not an email address.
    - `balanceUsdc` string, required: Non-negative exact decimal string with at most six fractional digits. Endpoint-specific positivity and amount limits still apply.
    - `balanceCredits` string, required: Non-negative exact decimal string with at most six fractional digits. Endpoint-specific positivity and amount limits still apply.
    - `status` 'active' | 'frozen', required

---

[API](https://skmtc.dev/paywithlocus/apis/locus-pro-api.md) - [All operations](https://skmtc.dev/paywithlocus/apis/locus-pro-api/llms.txt) - [OpenAPI document](https://skmtc.dev/paywithlocus/apis/locus-pro-api/revisions/aab8fa5d6cef?raw)