Service

​

Key Attributes

​

Service Status Values

​

Object Relationships

• Customer: Each service belongs to a customer account
• Proxies: Services contain individual proxy objects
• Service Adjustments: Track changes or modifications to the service
• Invoices: Financial records associated with the service
• Product: The product template the service was created from
• Proxy Users: Authentication entities that can access the service

​

Related Endpoints

​

Example Response

{
  "data": {
    "service_id": "API-1234-5678",
    "service_name": "AT&T ISP Proxies [US]",
    "service_type": "isp",
    "service_protocol": "ipv4",
    "service_quantity": 5,
    "service_status": "active",
    "service_cycle": "1:month",
    "service_creation_datetime": "2025-03-25 14:25:36",
    "service_expiry_datetime": "2025-04-25 14:25:36",
    "service_total": 1575,
    "service_is_automatic_collection": true,
    "service_is_pending_cancellation": false,
    "service_metadata": {
      "project": "Client XYZ",
      "department": "Marketing"
    },
    "country_id": "us",
    "service_fulfillment_filter": {
      "asn_id": 7018
    }
  },
  "message": "Service successfully retrieved."
}

​

Usage Notes

• A service can contain multiple proxies, up to the service_quantity value
• The service_fulfillment_filter allows you to target specific ASNs or regions
• Services automatically renew based on the service_cycle unless service_is_pending_cancellation is true
• The service_metadata field can be used to organize services by project, client, or department
• When a service is canceled, all associated proxies are deprovisioned
• To view proxies associated with a service, use the proxies=true parameter when retrieving the service

​

Residential and Mobile Services

• They do not have static proxies attached to them, unlike datacenter and ISP services
• Instead, they add data to your account’s residential or mobile data pool
• Data added through residential/mobile services never expires, even if the subscription is canceled
• Each purchase creates a residential_ledger or mobile_ledger entry recording the data addition
• Residential and Mobile services can be paused and unpaused, a feature not available for other service types
• When paused, billing stops but you retain access to any previously purchased data
• You can access this data through dynamic residential proxies and mobile proxies using the corresponding endpoints