Skip to main content

Overview

The user client provides methods to retrieve information about your ElevenLabs account, including subscription details and usage limits.

get()

Retrieve information about the authenticated user.

Method Signature

client.user.get(
    request_options: Optional[RequestOptions] = None
) -> User

Parameters

request_options
RequestOptions
Request-specific configuration.

Returns

User object containing:
subscription
object
Information about your current subscription plan
is_new_user
bool
Whether this is a new user account
xi_api_key
str
Your API key (redacted in response)

Example

from elevenlabs import ElevenLabs

client = ElevenLabs(api_key="YOUR_API_KEY")

# Get user information
user = client.user.get()

print(f"Subscription: {user.subscription.tier}")
print(f"Characters remaining: {user.subscription.character_count}")
print(f"Character limit: {user.subscription.character_limit}")
print(f"Voice limit: {user.subscription.voice_limit}")
print(f"Can use IVC: {user.subscription.can_use_instant_voice_cloning}")

Example Output

Subscription: creator
Characters remaining: 85432
Character limit: 100000
Voice limit: 30
Can use IVC: True

subscription

Access subscription-specific methods.

subscription.get()

Get detailed subscription information.
subscription = client.user.subscription.get()

print(f"Tier: {subscription.tier}")
print(f"Status: {subscription.status}")
print(f"Billing period: {subscription.billing_period}")

Async Usage

from elevenlabs import AsyncElevenLabs
import asyncio

async def get_user_info():
    client = AsyncElevenLabs(api_key="YOUR_API_KEY")
    
    user = await client.user.get()
    
    print(f"Subscription: {user.subscription.tier}")
    print(f"Characters: {user.subscription.character_count}/{user.subscription.character_limit}")

asyncio.run(get_user_info())

Use Cases

Usage Monitoring

Monitor your character usage and remaining quota

Feature Detection

Check which features are available in your plan

Billing Information

View subscription tier and renewal dates

Limit Management

Track voice limits and usage counters
  • Usage - Detailed usage statistics
  • Models - Available AI models

Build docs developers (and LLMs) love