Get user

1 curl https://api.elevenlabs.io/v1/user \ 2 -H "xi-api-key: <apiKey>"

1 { 2 "user_id": "1234567890", 3 "subscription": { 4 "tier": "trial", 5 "character_count": 17231, 6 "character_limit": 100000, 7 "can_extend_character_limit": false, 8 "allowed_to_extend_character_limit": false, 9 "voice_slots_used": 1, 10 "professional_voice_slots_used": 0, 11 "voice_limit": 120, 12 "voice_add_edit_counter": 212, 13 "professional_voice_limit": 1, 14 "can_extend_voice_limit": false, 15 "can_use_instant_voice_cloning": true, 16 "can_use_professional_voice_cloning": true, 17 "status": "free", 18 "max_character_limit_extension": 1, 19 "next_character_count_reset_unix": 1738356858, 20 "max_voice_add_edits": 230, 21 "currency": "usd", 22 "billing_period": "monthly_period", 23 "character_refresh_period": "monthly_period" 24 }, 25 "is_new_user": false, 26 "can_use_delayed_payment_methods": true, 27 "is_onboarding_completed": true, 28 "is_onboarding_checklist_completed": true, 29 "subscription_extras": { 30 "concurrency": 10, 31 "convai_concurrency": 10, 32 "force_logging_disabled": false, 33 "can_request_manual_pro_voice_verification": true, 34 "can_bypass_voice_captcha": true, 35 "moderation": { 36 "is_in_probation": false, 37 "enterprise_check_nogo_voice": false, 38 "enterprise_check_block_nogo_voice": false, 39 "never_live_moderate": false, 40 "nogo_voice_similar_voice_upload_count": 0, 41 "enterprise_background_moderation_enabled": false, 42 "on_watchlist": false, 43 "safety_status": "appeal_approved", 44 "warning_status": "warning" 45 }, 46 "convai_chars_per_minute": 1000, 47 "convai_asr_chars_per_minute": 1000, 48 "unused_characters_rolled_over_from_previous_period": 1000, 49 "overused_characters_rolled_over_from_previous_period": 1000, 50 "usage": { 51 "rollover_credits_quota": 1000, 52 "subscription_cycle_credits_quota": 1000, 53 "manually_gifted_credits_quota": 1000, 54 "rollover_credits_used": 1000, 55 "subscription_cycle_credits_used": 1000, 56 "manually_gifted_credits_used": 1000, 57 "paid_usage_based_credits_used": 1000, 58 "actual_reported_credits": 1000 59 } 60 }, 61 "xi_api_key": "8so27l7327189x0h939ekx293380l920", 62 "first_name": "John", 63 "is_api_key_hashed": false, 64 "xi_api_key_preview": "xi_api_key_preview", 65 "referral_link_code": "referral_link_code", 66 "partnerstack_partner_default_link": "partnerstack_partner_default_link" 67 }

Gets information about the user

Response

Successful Response

user_idstring

The unique identifier of the user.

subscriptionobject

Details of the user’s subscription.

is_new_userboolean

Whether the user is new.

can_use_delayed_payment_methodsboolean

Whether the user can use delayed payment methods.

is_onboarding_completedboolean

Whether the user’s onboarding is completed.

is_onboarding_checklist_completedboolean

Whether the user’s onboarding checklist is completed.

subscription_extrasobjectOptional

Optional additional details about the user’s subscription.

xi_api_keystringOptional

The API key of the user.

first_namestringOptional

First name of the user.

is_api_key_hashedbooleanOptionalDefaults to false

Whether the user’s API key is hashed.

xi_api_key_previewstringOptional

The preview of the user’s API key.

referral_link_codestringOptional

The referral link code of the user.

partnerstack_partner_default_linkstringOptional

The Partnerstack partner default link of the user.

Headers

Response

Errors