Skip to main content
  • Endpoint: GET https://api.heygen.com/v3/users/me
  • 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.

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 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.