Customer

​

Key Attributes

​

Object Relationships

• Proxy Users: Authentication entities created by the customer
• Services: Subscriptions to proxy products
• Proxies: Individual proxies allocated to the customer’s services
• Residential Ledger: Records of residential data usage
• Mobile Ledger: Records of mobile data usage

​

Related Endpoints

​

Example Response

{
  "data": {
    "customer_id": 1955,
    "customer_email_address": "[email protected]",
    "customer_first_name": "Steve",
    "customer_last_name": "Jobs",
    "credit_balance": 1245,
    "customer_proxy_user_limit": 5,
    "proxy_count": 100,
    "residential_bytes_left": 10737418240,
    "active_residential_service_id": "1955-8012-871",
    "mobile_bytes_left": 10737418240,
    "active_mobile_service_id": "1935-1517-112"
  },
  "message": "Customer successfully retrieved."
}

​

Usage Notes

• The credit_balance is displayed in cents (e.g., 1245 means $12.45)
• When purchasing via API, services must be paid with account credit
• The residential_bytes_left shows remaining data for residential proxies
• The mobile_bytes_left shows remaining data for mobile proxies
• The customer_proxy_user_limit determines how many proxy users you can create

​

Best Practices

• Regularly check your credit_balance before making API purchases
• Monitor your residential_bytes_left and mobile_bytes_left to avoid service interruptions
• Use the customer_id to reference your account in support requests