v1

latestOpenAPI 3.0.12026-07-265331168.0 KB
Customer

Retrieve Current Customer

Retrieves the profile of the currently authenticated customer, along with their credit balance.

get/public/user/customer/retrieve

Response

Successful Customer Profile Retrieve

messagestring

Status message for the retrieval.

Example response

{
  "data": {
    "active_mobile_service_id": "1955-8012-871",
    "active_mobile_service_is_paused": false,
    "active_residential_service_id": "1955-8012-871",
    "active_residential_service_subscription_is_paused": false,
    "active_service_types": [
      [
        "isp",
        "residential",
        "mobile"
      ]
    ],
    "country_id": "us",
    "country_id_billing": "us",
    "credit_balance": 1245,
    "customer_billing_line_one": "1",
    "customer_billing_line_two": "Infinite Loop",
    "customer_billing_name": "Steve Jobs",
    "customer_billing_subdivision_name": "Cupertino",
    "customer_billing_zip_code": "95014",
    "customer_creation_datetime": "2023-09-01 10:00:00",
    "customer_default_residential_free_trial_bytes": 1000000000,
    "customer_discord_id": "dis_ckf3malOP1s",
    "customer_discord_oauth_id": "0xfOavU6OUtXxhJ8",
    "customer_dob": "2023-09-01",
    "customer_email_address": "steve.jobs@apple.com",
    "customer_email_two_factor_authentication": true,
    "customer_first_name": "Steve",
    "customer_general_terms_agreement_datetime": "2023-09-01 10:00:00",
    "customer_google_oauth_id": "7Z6CbaOsoDg9AYds",
    "customer_id": 1955,
    "customer_is_residential_trial_eligible": true,
    "customer_iso_language_code": "en",
    "customer_kyc_level": 1,
    "customer_last_login_datetime": "2023-09-10 10:00:00",
    "customer_last_name": "Jobs",
    "customer_last_update_datetime": "2023-09-10 11:00:00",
    "customer_phone_number": "+14089961010",
    "customer_profile_image_url": "https://apple.com/steveprofilepic.jpg",
    "customer_proxy_user_limit": 5,
    "customer_requires_information_confirm": false,
    "customer_requires_password_change": false,
    "customer_residential_trial_disallow_reason": "kyc_verification_failure",
    "free_trial_is_pending": false,
    "kyc_is_pending": false,
    "mobile_bytes_left": 1000000000,
    "proxy_count": 100,
    "residential_bytes_left": 1000000000
  },
  "message": "Customer successfully retrieved."
}