Get a service

Connection hosts, available ports, capabilities, status, expiry and effective limits. Does not return the proxy password.

get/v1/services/{id}

Request

  • Base URL: https://api.trueproxies.com
  • URL: https://api.trueproxies.com/v1/services/{id}
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Query parameters

customer_idstring uuid

Owned sub-customer UUID. Resellers only; reads require reseller:read and writes reseller:purchase in addition to the operation scope. X-Customer-Id header is an alternative. Not allowed for me, wallet, trial, API keys, or reseller-management routes.

Response

ok

billing_read_onlyboolean required

Existing access remains available, but this service cannot be topped up or renewed. New plan purchases are separate.

capabilitiesstring[] required
citystring
comparison_passboolean

Free private comparison with fixed speed and expiry; cannot be purchased, topped up or renewed.

connects_per_secondinteger required

Effective limit for this service.

created_atstring date-time required
depletedboolean
display_namestring required

Unlimited service names reflect their actual speed and term; offer_key retains the original billing plan.

expires_atstring date-time
grace_untilstring date-time
hoststring required
idstring uuid required

Internal API identifier. Use reference for customer-facing display.

max_connectionsinteger required

Effective limit for this service.

offer_keystring required
product'residential_ipv4_gb' | 'residential_ipv4_unlimited' | 'datacenter_ipv6' | 'trial' | 'residential_ipv6' required
referencestring required

Stable, unique customer-facing reference.

renewals_enabledboolean required
speed_bpsinteger

0 for paid residential_ipv4_gb means no additional TrueProxies speed cap. Private comparison passes have a fixed 50000000 bps cap. residential_ipv4_unlimited retains its positive plan speed. Upstream capacity and availability still apply. Trials and datacenter plans retain their speed limits.

starts_atstring date-time
status'pending' | 'active' | 'expired' | 'closed' | 'suspended' | 'failed' required
term'hour' | 'day' | 'week' | 'month'
term_labelstring

Actual fixed duration for a free Unlimited grant, such as 3 hours. Overrides the recurring term label in customer views.

trial_started_atstring date-time

First recorded trial traffic; absent until the first request starts the 30-minute window.

usage_source'node' required
username_basestring required
whitelist_entriesinteger

Example response

{
  "reference": "SVC-001001"
}

Changes

No recorded changes to this operation across all 1 revision of this API.