> ## Documentation Index
> Fetch the complete documentation index at: https://heygen-1fa696a7.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Current User

> Retrieve the authenticated user's profile, credit balance, and plan tier from the HeyGen API. Useful for in-app credit displays and account-management UIs.

![](https://mintcdn.com/heygen-1fa696a7/hfMXXwJzjE7vBSYZ/images/theme/research.webp?fit=max\&auto=format\&n=hfMXXwJzjE7vBSYZ\&q=85\&s=3e4c2594813dcfd56985f3d63e3ba321)

* Endpoint: [`GET https://api.heygen.com/v3/users/me`](https://heygen-1fa696a7.mintlify.site/reference/get-current-user)
* Purpose: Returns the authenticated user's profile (`username`, `email`, `first_name`, `last_name`), remaining credits or balance, and billing details. Use this to check your account status or remaining quota before making API calls.

```bash theme={null}
curl -X GET "https://api.heygen.com/v3/users/me" \
  -H "X-Api-Key: $HEYGEN_API_KEY"
```

### Billing Types

The `billing_type` field tells you which of the three billing objects to read. Only one is populated at a time; the others are `null`. The [reference](https://heygen-1fa696a7.mintlify.site/reference/get-current-user.md) lists every field.

* **`wallet`**: prepaid balance, typically for API key auth. Read `wallet.remaining_balance` in `wallet.currency` (`"usd"` or `"credits"`), plus the `wallet.auto_reload` settings (`enabled`, `threshold_usd`, `amount_usd`).
* **`subscription`**: per-pool credit balances for web-plan subscriptions. `subscription.plan` is the tier (`"free"`, `"starter"`, `"creator"`, `"pro"`, `"team"`, `"enterprise"`, or `"business_plus"`); `subscription.credits` holds `premium_credits` (`remaining`, `resets_at`) and `add_on_credits` (`remaining`).
* **`usage_based`**: metered billing with an optional spending cap, in `usage_based.spending_current_usd` and `usage_based.spending_cap_usd`.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.