GET
/
public
/
user
/
service
/
retrieve
/
{service_id}
curl --request GET \
  --url https://api.pingproxies.com/1.0/public/user/service/retrieve/{service_id} \
  --header 'X-API-Private-Key: <api-key>' \
  --header 'X-API-Public-Key: <api-key>'
{
  "data": {
    "country_id": "us",
    "payment_method_id": "pm_1NjyqfB2BUlqim5l2LgRUo0a",
    "service_creation_datetime": "2023-09-12 10:00:00",
    "service_cycle": "1:month",
    "service_dispatch_datetime": "2023-09-12 11:00:00",
    "service_earliest_cancellation_datetime": "2023-09-12 12:00:00",
    "service_expiry_datetime": "2023-10-12 10:00:00",
    "service_id": "API-1234-5678",
    "service_image": "https://apple.com/image.png",
    "service_is_automatic_collection": true,
    "service_is_pending_cancellation": false,
    "service_last_update_datetime": "2023-09-12 12:00:00",
    "service_metadata": {
      "resell_customer_id": "APPL-9876-5432"
    },
    "service_name": "Premium ISP",
    "service_promotional_code": "PROMO2023",
    "service_protocol": "ipv4",
    "service_quantity": 5,
    "service_status": "active",
    "service_subscription_id": "sub_1NpPVfB2BUlqim5lA374YoIh",
    "service_subscription_is_paused": false,
    "service_total": 100,
    "service_type": "isp"
  },
  "message": "Service successfully retrieved."
}

Authorizations

​
X-API-Private-Key
string
header
required

Private API key for user-level authentication.

​
X-API-Public-Key
string
header
required

Public API key for user-level authentication.

Path Parameters

​
service_id
string
required

ID of the Service to retrieve

Query Parameters

​
proxies
boolean

If the proxies associated with the service should be returned

Response

200 - application/json
Successful Service Retrieve

Service retrieve was successful.

​
data
object

Retrieved Service item details.

​
message
string

Status message for the retrieval.