Subscription Info

Subscription Info

This endpoint returns detailed information about your current residential proxy subscription, including the subscription ID, plan details, billing cycle, usage, bandwidth, connections, and available authentication slots.

GET/dev/v1.0/subscriptions/residential
Limit: 10 requests / 60s
Required:API-Key
Important: Copy the subscription "id": "su_69af..." and one slot "id": "sl_69af..." from the response. Each active residential slot stores its own proxies and is required for further requests. 
import requests, json


        def get_residential_subscription(api_key):

          url = "https://api.ghostealth.com/dev/v1.0/subscriptions/residential"

          headers = {

            "Content-Type": "application/json",

            "Authorization": f"ApiKey {api_key}"

          }


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

          print("Residential Subscription Response:", res.status_code)

          print(json.dumps(res.json(), indent=2))


        api_key = "xxx"

        get_residential_subscription(api_key)
Example Response:
Toggle Response
{
        "data": {
        "id": "su_69afbaa5bc32119ad6daa8fe",
        "status": "ACTIVE",
        "type": "STANDARD",
        "canceled": false,
        "period": {
        "start": {
        "timestamp": 1773124261347,
        "date": 1773124261347
        },
        "end": {
        "timestamp": 1775802661347,
        "date": 1775802661347
        }
        },
        "consumption": {
        "bytes": 0,
        "requests": 0
        },
        "plan": {
        "id": "pl_69afba9cbc32119ad6daa8f8",
        "title": "GS-RES 2",
        "description": "Monthly billing",
        "billingCycle": "MONTHLY",
        "price": {
        "currency": "USD",
        "netAmount": 840,
        "grossAmount": 1000,
        "taxAmount": 160,
        "feeAmount": 0,
        "taxRate": 19.0
        },
        "configuration": {
        "type": "RESIDENTIAL",
        "proxies": 50000000,
        "bandwidth": 2147483648,
        "bandwidthInGB": 2.0,
        "connections": 500,
        "authentications": 4
        }
        },
        "slots": [
        {
        "id": "sl_69afbaa5bc32119ad6daa900",
        "status": "ENABLED",
        "state": "UNBOUND",
        "synchronization": "SYNCED",
        "type": "CREDENTIAL"
        },
        {
        "id": "sl_69afbaa5bc32119ad6daa901",
        "status": "ENABLED",
        "state": "UNBOUND",
        "synchronization": "SYNCED",
        "type": "CREDENTIAL"
        },
        {
        "id": "sl_69afbaa5bc32119ad6daa902",
        "status": "ENABLED",
        "state": "UNBOUND",
        "synchronization": "SYNCED",
        "type": "CREDENTIAL"
        },
        {
        "id": "sl_69afbaa5bc32119ad6daa903",
        "status": "ENABLED",
        "state": "UNBOUND",
        "synchronization": "SYNCED",
        "type": "CREDENTIAL"
        }
        ]
        }
        }
Note: The response includes your residential bandwidth, connection limit, authentication count, and all available slot IDs for the subscription.