Skip to main content
  • Endpoint: GET https://api.heygen.com/v3/user/me
  • Purpose: Returns the authenticated user’s profile, remaining credits or balance, and billing details. Use this to check your account status or remaining quota before making API calls.

​
Authentication

HeaderValue
X-Api-KeyYour HeyGen API key
AuthorizationBearer YOUR_ACCESS_TOKEN (OAuth)

​
Quick Example

curl -X GET "https://api.heygen.com/v3/user/me" \
  -H "X-Api-Key: $HEYGEN_API_KEY"

​
Response

{
  "data": {
    "username": "jane_doe",
    "email": "[email protected]",
    "first_name": "Jane",
    "last_name": "Doe",
    "billing_type": "wallet",
    "wallet": {
      "currency": "usd",
      "remaining_balance": 42.50,
      "auto_reload": {
        "enabled": false
      }
    },
    "subscription": null,
    "usage_based": null
  }
}

​
Response Fields

FieldTypeDescription
usernamestringAccount username.
emailstring or nullAccount email.
first_namestring or nullFirst name.
last_namestring or nullLast name.
billing_typestring or nullWhich billing object is populated: "wallet", "subscription", or "usage_based".

​
Billing Types

The billing_type field tells you which of the three billing objects to read. Only one is populated at a time. Wallet (billing_type: "wallet") — Prepaid balance, typically for API key auth.
FieldTypeDescription
wallet.currencystring"usd" or "credits"
wallet.remaining_balancenumber or nullCurrent balance.
wallet.auto_reload.enabledbooleanWhether auto-reload is on.
wallet.auto_reload.threshold_usdnumber or nullBalance threshold that triggers reload.
wallet.auto_reload.amount_usdnumber or nullAmount added on reload.
Subscription (billing_type: "subscription") — Per-pool credit balances, typically for OAuth apps.
FieldTypeDescription
subscription.planstringPlan tier: "free", "starter", "creator", "pro", "team", "enterprise", or "business_plus".
subscription.credits.premium_credits.remaininginteger or nullRemaining premium credits.
subscription.credits.premium_credits.resets_atstring or nullWhen the credit pool resets.
subscription.credits.add_on_credits.remaininginteger or nullRemaining add-on credits.
Usage-based (billing_type: "usage_based") — Metered billing with optional spending cap.
FieldTypeDescription
usage_based.spending_current_usdnumber or nullCurrent spend this period.
usage_based.spending_cap_usdnumber or nullSpending cap (if set).