HEheygen
User

Get current user info, remaining credits, and billing

Changed on

Returns the authenticated user's profile, remaining credits or balance, and billing details. The billing_type field indicates which billing object is populated: wallet (prepaid balance), subscription (OAuth credit pools), or usage_based (metered spending).

get/v1/user/me

Request

  • Base URL
    https://api.heygen.com
  • URL
    https://api.heygen.com/v1/user/me
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Response

Successful response

codeinteger

API status code (100 = success)

messagestring nullable

Example response

{
  "code": 100,
  "data": {
    "username": "user_abc123",
    "email": "user@example.com",
    "first_name": "Jane",
    "last_name": "Doe",
    "wallet": {
      "remaining_balance": 125.5,
      "auto_reload": {
        "enabled": true,
        "threshold_usd": 10,
        "amount_usd": 50
      }
    },
    "subscription": {
      "credits": {
        "premium_credits": {
          "remaining": 500,
          "resets_at": "2024-05-01T00:00:00Z"
        },
        "add_on_credits": {
          "remaining": 500,
          "resets_at": "2024-05-01T00:00:00Z"
        }
      }
    },
    "usage_based": {
      "spending_current_usd": 42.5,
      "spending_cap_usd": 100,
      "included_credits": 4444,
      "remaining_credits": 4426.9
    }
  }
}

Changes