Connecting others

Get User's Account Information

After successfully authenticating with HeyGen, you can retrieve detailed account information using the following endpoint:

curl -X GET https://api2.heygen.com/v1/pacific/account.get \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

{
  "code": 100,
  "data": {
    "experiments": {
      "asset_face_swap": { "pass": false },
      "checkout_ui": { "pass": false },
      "consent_validation": { "group": "A", "pass": true },
      "create_button": { "pass": false },
      "dirty_word_block_level": { "pass": false },
      "exact_draft": { "pass": false },
      "instant_paid": { "group": "test", "pass": true },
      "notification": { "group": "A", "pass": true },
      "old_avatar": { "group": "A", "pass": true },
      "onboarding": { "pass": false },
      "onboarding2_bak": { "pass": false },
      "paywall_ui": { "pass": false },
      "studio_v3": { "pass": false }
    },
    "features": {
      "business_vt": true,
      "instant_avatar_upload": true,
      "new_stripe": true,
      "paid_voice": true,
      "vt_instruction": true
    },
    "space_info": {
      "owner_username": "1fa4fc1ec8d240ecbee71949a158bfd6",
      "permission_list": [
        "permission.draft.write",
        "permission.api.all",
        "permission.fe.payment",
        "permission.third_party_voice.all",
        "permission.fe.api_access",
        "permission.fe.permanent_content_deletion",
        "permission.role.write",
        "permission.asset.write",
        "permission.video.write",
        "permission.fe.content_access",
        "permission.payment.all",
        "permission.fe.credit_consumption"
      ],
      "role_list": [{ "id": "role_id.super_admin", "name": "Super Admin" }],
      "user_plan_v2": {
        "amount": 0.0,
        "api_access": true,
        "available_quota": {
          "regular": 300,
          "streaming_avatar_instance_quota": 1
        },
        "available_quota_v2": {
          "regular": { "amount": 300, "quota_type": "regular" },
          "streaming_avatar_instance_quota": {
            "amount": 1,
            "quota_type": "regular"
          }
        },
        "cancel_at_period_end": false,
        "created_ts": 1724491643,
        "downgrade_at_period_end": false,
        "downgrade_price_id": null,
        "downgrade_ts": null,
        "expired_ts": 1756027643,
        "is_gift": true,
        "is_paid": true,
        "is_unlimited": false,
        "left_days": 349,
        "pause_at_period_end": false,
        "period": "month",
        "price_id": "heygen_enterprise_trial_internal",
        "remain_quota": 300,
        "remain_video": null,
        "resumes_at": 0,
        "self_serve_enterprise": false,
        "streaming_avatar_monthly_subscription_id": "",
        "streaming_avatar_subscription_id": "",
        "streaming_avatar_subscription_renew_ts": null,
        "streaming_avtar_monthly_subscription_renew_ts": null,
        "subscription_start_ts": "Sat, 24 Aug 2024 09:27:23 GMT",
        "subscription_type": "normal",
        "tier": "enterprise",
        "tier_id": "heygen_enterprise_trial_gift",
        "total_quota_in_min": 0,
        "total_quota_in_second": 0
      }
    },
    "user": {
      "ack_agreement": true,
      "asset_upload_limit": {
        "audio": 104857600,
        "image": 209715200,
        "video": 209715200
      },
      "disable_survey": true,
      "email": "<email>",
      "enable_payment": true,
      "has_api_access": true,
      "has_paid": true,
      "instant_avatar_access": true,
      "instant_avatar_slots": 5,
      "internal": false,
      "is_set_password": true,
      "is_subscription_active": true,
      "mfa": false,
      "phone": "",
      "pv_footage_duration_limit": null,
      "referral_quota": {
        "remaining_in_minutes": 0,
        "remaining_in_seconds": 0,
        "total_in_minutes": 0,
        "total_in_seconds": 0
      },
      "registration_ts": 1696430049,
      "survey": {
        "company_size": ["Only me"],
        "hear_from": ["TikTok"],
        "industry": ["Software, Online Service"],
        "role": ["Other:"],
        "video_content": ["Entertainment"]
      },
      "testing_group": "B",
      "third_party": {
        "facebook": { "is_bind": false, "name": null },
        "google": { "is_bind": true, "name": "<full-name>" },
        "rewardful": ""
      },
      "totp_created_ts": null,
      "user_hash": "ff270f7f389ee6efcb399157287612779ce7cf27abb60af9ad1b529746724f79",
      "user_id": "1fa4fc1ec8d240ecbee71949a158bfd6",
      "username": "1fa4fc1ec8d240ecbee71949a158bfd6",
      "usertype": "gift_subscription",
      "video_duration_limit": 3600.0,
      "video_translate_duration_limit": 3600.0,
      "video_translate_filesize_limit": 5368709120
    },
    "user_plan_v2": {
      "amount": 0.0,
      "api_access": true,
      "available_quota": {
        "regular": 300,
        "streaming_avatar_instance_quota": 1
      },
      "available_quota_v2": {
        "regular": { "amount": 300, "quota_type": "regular" },
        "streaming_avatar_instance_quota": {
          "amount": 1,
          "quota_type": "regular"
        }
      },
      "cancel_at_period_end": false,
      "created_ts": 1724491643,
      "downgrade_at_period_end": false,
      "downgrade_price_id": null,
      "downgrade_ts": null,
      "expired_ts": 1756027643,
      "is_gift": true,
      "is_paid": true,
      "is_unlimited": false,
      "left_days": 349,
      "pause_at_period_end": false,
      "period": "month",
      "price_id": "heygen_enterprise_trial_internal",
      "remain_quota": 300,
      "remain_video": null,
      "resumes_at": 0,
      "self_serve_enterprise": false,
      "streaming_avatar_monthly_subscription_id": "",
      "streaming_avatar_subscription_id": "",
      "streaming_avatar_subscription_renew_ts": null,
      "streaming_avtar_monthly_subscription_renew_ts": null,
      "subscription_start_ts": "Sat, 24 Aug 2024 09:27:23 GMT",
      "subscription_type": "normal",
      "tier": "enterprise",
      "tier_id": "heygen_enterprise_trial_gift",
      "total_quota_in_min": 0,
      "total_quota_in_second": 0
    }
  },
  "message": "Success"
}

Replace YOUR_ACCESS_TOKEN with the access token obtained during the OAuth process.

The response includes detailed information about the user's account, experiments, features, and subscription plan.

Experiments: A list of feature experiments and their status for the user.
Features: Enabled features for the user's account.
Space Info: Information about the user's workspace, including permissions and roles.
User: Basic user information, including email, registration date, and subscription status.
User Plan: Detailed information about the user's subscription plan, including quotas, tier, and expiration.