PLESK - SUBSCRIPTIONS - SUBSCRIPTION DETAIL

Plesk - Subscriptions - Subscription Detail API Endpoints

Complete documentation for all Plesk - Subscriptions - Subscription Detail related endpoints.

GET

Get Subscription Detail

Get detailed information about a specific Plesk subscription.

Endpoint Details

HTTP Request

GET https://0xhost.com/API/plesk/subscriptions/detail

Parameters

Parameter	Type	Required	Description
`id`	string	Yes	Subscription UUID

Authentication

API Key Required in header

Headers

Header	Value	Required	Description
`x-api-key`	`your_api_key_here`	Yes	Your unique API key for authentication
`Content-Type`	`application/json`	Optional	Recommended for consistent response handling

Response Fields

Field	Type	Description
`success`	boolean	Indicates if the operation was successful
`message`	string	Response message describing the result
`data`	object/array	Contains the response data

Success Response

API Response Example

{
    "success": true,
    "subscription": {
        "id": "sub123-4567-8901-2345-678901234567",
        "domain_name": "example.com",
        "status": "active",
        "price": "9.99",
        "plan_name": "Basic",
        "client_id": "client123-4567-8901-2345-678901234567",
        "client_name": "John Doe",
        "created_at": "2025-03-01 10:00:00",
        "expires_at": "2025-04-01 10:00:00",
        "auto_renew": true,
        "ftp_username": "example_ftp"
    },
    "orders": [
        {
            "id": "order123-4567-8901-2345-678901234567",
            "order_number": "PLK_20250301_123456",
            "amount": "9.99",
            "status": "completed",
            "created_at": "2025-03-01 10:00:00"
        }
    ]
}

Code Examples

Programming Languages

JavaScript (Fetch API)

async function makeRequest() {
  try {
    const response = await fetch('https://0xhost.com/API/plesk/subscriptions/detail?id=sub123-4567-8901-2345-678901234567', {
      method: 'GET',
      headers: {
        'x-api-key': 'your_api_key_here',
        'Content-Type': 'application/json'
      }
    });

    const data = await response.json();
    console.log('Response:', data);
    return data;
  } catch (error) {
    console.error('Error:', error);
  }
}

Python (Requests)

import requests

def make_request(api_key):
    url = 'https://0xhost.com/API/plesk/subscriptions/detail?id=sub123-4567-8901-2345-678901234567'
    headers = {
        'x-api-key': api_key,
        'Content-Type': 'application/json'
    }

    response = requests.get(url, headers=headers)

    if response.status_code == 200:
        return response.json()
    else:
        print(f'Error: {response.status_code}')
        return None

PHP (cURL)

function makeRequest($apiKey) {
    $url = 'https://0xhost.com/API/plesk/subscriptions/detail?id=sub123-4567-8901-2345-678901234567';

    $ch = curl_init();
    curl_setopt($ch, CURLOPT_URL, $url);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
    curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
    curl_setopt($ch, CURLOPT_HTTPHEADER, [
        'x-api-key: ' . $apiKey,
        'Content-Type: application/json'
    ]);

    $response = curl_exec($ch);
    $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
    curl_close($ch);

    return json_decode($response, true);
}

cURL Command

curl -X GET \
  'https://0xhost.com/API/plesk/subscriptions/detail?id=sub123-4567-8901-2345-678901234567' \
  -H 'x-api-key: your_api_key_here' \
  -H 'Content-Type: application/json'

0xHost API