# Plans

Active plans management endpoints

## List all active plans

> Returns all active plans for the authenticated user, including sub-users and unlimited residential accounts.

```json
{"openapi":"3.0.0","info":{"title":"PlainProxies User API","version":"1.0.0"},"tags":[{"name":"Plans","description":"Active plans management endpoints"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","description":"API Key authentication. Get your key from the Dashboard Settings page.","name":"X-API-KEY","in":"header"}},"schemas":{"SubUser":{"title":"Sub-User","description":"A sub-user represents a proxy credential that can be used for authentication. Sub-users are associated with different proxy types (datacenter, residential, ISP, IPv6) and have their own bandwidth allocations and settings.","required":["uuid","name","type","status","created_at","updated_at"],"properties":{"uuid":{"description":"Unique identifier for the sub-user. Use this UUID in all API operations.","type":"string","format":"uuid"},"name":{"description":"Username for proxy authentication. This is the login credential used when connecting to the proxy server.","type":"string"},"type":{"description":"Proxy product type. Determines the IP pool and features available.","type":"string","enum":["datacenter","residential","ipv6","isp"]},"status":{"description":"Current status of the sub-user. Only \"active\" sub-users can be used for proxy connections.","type":"string","enum":["active","expired","suspended"]},"expires_at":{"description":"Expiration date/time in ISO 8601 format. Null for sub-users with no expiration. After expiration, status changes to \"expired\".","type":"string","format":"date-time","nullable":true},"created_at":{"description":"Creation timestamp in ISO 8601 format.","type":"string","format":"date-time"},"updated_at":{"description":"Last update timestamp in ISO 8601 format.","type":"string","format":"date-time"},"credentials":{"description":"Proxy authentication credentials. Only included when `include=credentials` is specified.","properties":{"username":{"description":"Proxy authentication username.","type":"string"},"password":{"description":"Proxy authentication password.","type":"string"}},"type":"object","nullable":true},"traffic":{"description":"Bandwidth usage information. Only included when `include=traffic` is specified.","properties":{"used":{"description":"Bandwidth used in GB.","type":"number","format":"float"},"total":{"description":"Total bandwidth allocation in GB.","type":"number","format":"float"},"remaining":{"description":"Remaining bandwidth in GB.","type":"number","format":"float"},"unit":{"description":"Unit of measurement.","type":"string"}},"type":"object","nullable":true},"proxy_settings":{"description":"Advanced proxy settings. Only included when `include=proxy_settings` is specified.","properties":{"whitelisted_ips":{"description":"Allowed IP addresses.","type":"array","items":{"type":"string"}},"country_list":{"description":"Country distribution for datacenter/ISP.","type":"object"},"high_priority":{"description":"High priority routing enabled.","type":"boolean"},"high_concurrency":{"description":"High concurrency mode enabled.","type":"boolean"},"purchased_ip_count":{"description":"Number of IPs purchased.","type":"integer","nullable":true}},"type":"object","nullable":true},"ip_list":{"description":"List of assigned proxy IPs. Only available for ISP and Datacenter sub-users. Included when `include=ip_list` is specified.","type":"array","items":{"type":"string"},"nullable":true}},"type":"object"},"UnlimitedAccount":{"properties":{"uuid":{"type":"string","format":"uuid"},"username":{"type":"string"},"status":{"type":"string","enum":["active","expired","disabled"]},"is_enabled":{"type":"boolean"},"mbps_limit":{"description":"Speed limit in Mbps, 0 for unlimited","type":"integer"},"bandwidth_limit":{"description":"Bandwidth limit in GB, 0 for unlimited","type":"integer"},"threads_limit":{"description":"Threads limit, 0 for unlimited","type":"integer"},"bandwidth_used":{"description":"Bandwidth used in bytes","type":"integer"},"duration_days":{"type":"integer"},"expires_at":{"type":"string","format":"date-time","nullable":true},"last_active_at":{"type":"string","format":"date-time","nullable":true},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"credentials":{"properties":{"username":{"type":"string"},"password":{"type":"string"}},"type":"object","nullable":true},"location":{"properties":{"id":{"type":"integer"},"name":{"type":"string"},"country_code":{"type":"string"}},"type":"object","nullable":true},"server":{"properties":{"id":{"type":"integer"},"hostname":{"type":"string"}},"type":"object","nullable":true},"plan":{"properties":{"id":{"type":"integer"},"name":{"type":"string"}},"type":"object","nullable":true},"settings":{"properties":{"blocked_domains":{"type":"array","items":{"type":"string"}},"authorized_ips":{"type":"array","items":{"type":"string"}},"port_config_http":{"type":"array","items":{"type":"object"}},"port_config_socks5":{"type":"array","items":{"type":"object"}}},"type":"object","nullable":true}},"type":"object"}},"responses":{"Unauthorized":{"description":"Authentication failed. Ensure your API key is valid and included in the X-API-KEY header.","headers":{"WWW-Authenticate":{"description":"Authentication scheme hint","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"properties":{"success":{"type":"boolean"},"error":{"properties":{"code":{"type":"string","enum":["API_KEY_MISSING","INVALID_API_KEY","USER_NOT_FOUND"]},"message":{"type":"string"}},"type":"object"}},"type":"object"}}}}}},"paths":{"/plans":{"get":{"tags":["Plans"],"summary":"List all active plans","description":"Returns all active plans for the authenticated user, including sub-users and unlimited residential accounts.","operationId":"4c03b00edadfc01a6df601d0e22d8853","parameters":[{"name":"filter[type]","in":"query","description":"Filter by plan type (datacenter, residential, ipv6, isp, unlimited)","required":false,"schema":{"type":"string","enum":["datacenter","residential","ipv6","isp","unlimited"]}},{"name":"filter[status]","in":"query","description":"Filter by status (active, used, inactive)","required":false,"schema":{"type":"string","enum":["active","used","inactive"]}},{"name":"include","in":"query","description":"Comma-separated list of relations to include (credentials, traffic, subscription, proxy_settings)","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"List of active plans","content":{"application/json":{"schema":{"properties":{"success":{"type":"boolean"},"data":{"properties":{"sub_users":{"type":"array","items":{"$ref":"#/components/schemas/SubUser"}},"unlimited_accounts":{"type":"array","items":{"$ref":"#/components/schemas/UnlimitedAccount"}},"meta":{"properties":{"total_sub_users":{"type":"integer"},"total_unlimited":{"type":"integer"},"total":{"type":"integer"}},"type":"object"}},"type":"object"}},"type":"object"}}}},"401":{"$ref":"#/components/responses/Unauthorized"}}}}}}
```

## Get plan details

> Returns details for a specific plan. Works with both sub-users and unlimited residential accounts.

```json
{"openapi":"3.0.0","info":{"title":"PlainProxies User API","version":"1.0.0"},"tags":[{"name":"Plans","description":"Active plans management endpoints"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","description":"API Key authentication. Get your key from the Dashboard Settings page.","name":"X-API-KEY","in":"header"}},"schemas":{"SubUser":{"title":"Sub-User","description":"A sub-user represents a proxy credential that can be used for authentication. Sub-users are associated with different proxy types (datacenter, residential, ISP, IPv6) and have their own bandwidth allocations and settings.","required":["uuid","name","type","status","created_at","updated_at"],"properties":{"uuid":{"description":"Unique identifier for the sub-user. Use this UUID in all API operations.","type":"string","format":"uuid"},"name":{"description":"Username for proxy authentication. This is the login credential used when connecting to the proxy server.","type":"string"},"type":{"description":"Proxy product type. Determines the IP pool and features available.","type":"string","enum":["datacenter","residential","ipv6","isp"]},"status":{"description":"Current status of the sub-user. Only \"active\" sub-users can be used for proxy connections.","type":"string","enum":["active","expired","suspended"]},"expires_at":{"description":"Expiration date/time in ISO 8601 format. Null for sub-users with no expiration. After expiration, status changes to \"expired\".","type":"string","format":"date-time","nullable":true},"created_at":{"description":"Creation timestamp in ISO 8601 format.","type":"string","format":"date-time"},"updated_at":{"description":"Last update timestamp in ISO 8601 format.","type":"string","format":"date-time"},"credentials":{"description":"Proxy authentication credentials. Only included when `include=credentials` is specified.","properties":{"username":{"description":"Proxy authentication username.","type":"string"},"password":{"description":"Proxy authentication password.","type":"string"}},"type":"object","nullable":true},"traffic":{"description":"Bandwidth usage information. Only included when `include=traffic` is specified.","properties":{"used":{"description":"Bandwidth used in GB.","type":"number","format":"float"},"total":{"description":"Total bandwidth allocation in GB.","type":"number","format":"float"},"remaining":{"description":"Remaining bandwidth in GB.","type":"number","format":"float"},"unit":{"description":"Unit of measurement.","type":"string"}},"type":"object","nullable":true},"proxy_settings":{"description":"Advanced proxy settings. Only included when `include=proxy_settings` is specified.","properties":{"whitelisted_ips":{"description":"Allowed IP addresses.","type":"array","items":{"type":"string"}},"country_list":{"description":"Country distribution for datacenter/ISP.","type":"object"},"high_priority":{"description":"High priority routing enabled.","type":"boolean"},"high_concurrency":{"description":"High concurrency mode enabled.","type":"boolean"},"purchased_ip_count":{"description":"Number of IPs purchased.","type":"integer","nullable":true}},"type":"object","nullable":true},"ip_list":{"description":"List of assigned proxy IPs. Only available for ISP and Datacenter sub-users. Included when `include=ip_list` is specified.","type":"array","items":{"type":"string"},"nullable":true}},"type":"object"},"UnlimitedAccount":{"properties":{"uuid":{"type":"string","format":"uuid"},"username":{"type":"string"},"status":{"type":"string","enum":["active","expired","disabled"]},"is_enabled":{"type":"boolean"},"mbps_limit":{"description":"Speed limit in Mbps, 0 for unlimited","type":"integer"},"bandwidth_limit":{"description":"Bandwidth limit in GB, 0 for unlimited","type":"integer"},"threads_limit":{"description":"Threads limit, 0 for unlimited","type":"integer"},"bandwidth_used":{"description":"Bandwidth used in bytes","type":"integer"},"duration_days":{"type":"integer"},"expires_at":{"type":"string","format":"date-time","nullable":true},"last_active_at":{"type":"string","format":"date-time","nullable":true},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"credentials":{"properties":{"username":{"type":"string"},"password":{"type":"string"}},"type":"object","nullable":true},"location":{"properties":{"id":{"type":"integer"},"name":{"type":"string"},"country_code":{"type":"string"}},"type":"object","nullable":true},"server":{"properties":{"id":{"type":"integer"},"hostname":{"type":"string"}},"type":"object","nullable":true},"plan":{"properties":{"id":{"type":"integer"},"name":{"type":"string"}},"type":"object","nullable":true},"settings":{"properties":{"blocked_domains":{"type":"array","items":{"type":"string"}},"authorized_ips":{"type":"array","items":{"type":"string"}},"port_config_http":{"type":"array","items":{"type":"object"}},"port_config_socks5":{"type":"array","items":{"type":"object"}}},"type":"object","nullable":true}},"type":"object"}},"responses":{"Unauthorized":{"description":"Authentication failed. Ensure your API key is valid and included in the X-API-KEY header.","headers":{"WWW-Authenticate":{"description":"Authentication scheme hint","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"properties":{"success":{"type":"boolean"},"error":{"properties":{"code":{"type":"string","enum":["API_KEY_MISSING","INVALID_API_KEY","USER_NOT_FOUND"]},"message":{"type":"string"}},"type":"object"}},"type":"object"}}}},"NotFound":{"description":"The requested resource does not exist or you do not have access to it.","content":{"application/json":{"schema":{"properties":{"success":{"type":"boolean"},"error":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"type":"object"}},"type":"object"}}}}}},"paths":{"/plans/{uuid}":{"get":{"tags":["Plans"],"summary":"Get plan details","description":"Returns details for a specific plan. Works with both sub-users and unlimited residential accounts.","operationId":"ed53c753c6e7e51003b2b8eb54b67891","parameters":[{"name":"uuid","in":"path","description":"Plan UUID","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"include","in":"query","description":"Comma-separated list of relations to include","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Plan details","content":{"application/json":{"schema":{"properties":{"success":{"type":"boolean"},"data":{"properties":{"type":{"type":"string","enum":["sub_user","unlimited_account"]},"plan":{"oneOf":[{"$ref":"#/components/schemas/SubUser"},{"$ref":"#/components/schemas/UnlimitedAccount"}]}},"type":"object"}},"type":"object"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.plainproxies.com/api-documentation/billing-and-invoicing/plans.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.