v1

latestOpenAPI 3.0.12026-07-265331168.0 KB

Service

Retrieve Service

Retrieves a specific Service based on the provided ID for the current user's account. If the 'show_proxies' parameter is set to 'True', it will also fetch proxies associated with each service and add them to the result.

get/public/user/service/retrieve/{service_id}

Path parameters

service_idstring required

ID of the Service to retrieve

Query parameters

proxiesboolean

If the proxies associated with the service should be returned

Response

Successful Service Retrieve

messagestring

Status message for the retrieval.

Example response

{
  "data": {
    "country_id": "us",
    "open_invoice_id": "inv_1OCNVFFKo7UQ3XWITWlqGWYQ",
    "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",
    "subscription_schedule_id": "sub_sched_1OCNVFFKo7UQ3XWITWlqGWYQ"
  },
  "message": "Service successfully retrieved."
}