> For the complete documentation index, see [llms.txt](https://docs.plainproxies.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.plainproxies.com/subuser-api-documentation/overview-1.md).

# Overview

### Overview

The PlainProxies Reseller API provides programmatic access to manage sub-users, generate proxies, configure webhooks, and handle billing for reseller accounts.

#### Key Features

* **Sub-Users**: Create, update, suspend, and delete sub-user proxy credentials
* **Proxy Generation**: Generate rotating or sticky session proxies with geo-targeting
* **Proxy Settings**: Configure port, domain, and URL whitelisting (with admin approval)
* **Unlimited Residential**: Purchase, upgrade, renew, and manage unlimited bandwidth plans
* **Webhooks**: Receive real-time HTTP notifications for proxy settings changes and fair usage events
* **Billing**: View plans, subscriptions, and invoices

#### Authentication

All API requests require authentication via the `X-API-KEY` header. You can find your API key in the [Dashboard Settings](https://dashboard.plainproxies.com/account/api-keys).

```
X-API-KEY: PlainProxies_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
```

> **Reseller status required.** This API requires an active reseller account. Standard users can use the User API instead.

#### Rate Limits

* **Standard endpoints**: 60 requests/minute
* **Write operations**: 30 requests/minute
* **Expensive operations** (proxy generation, purchases): 10 requests/minute

#### Response Format

All responses follow a consistent JSON structure:

```json
{
  "success": true,
  "data": { ... },
  "message": "Optional message",
  "meta": { "pagination info if applicable" }
}
```

#### Webhook Signing

Webhook deliveries include an `X-Webhook-Signature` header containing an HMAC-SHA256 signature of the JSON body. Verify it against your webhook secret to confirm authenticity. See the **Webhooks** section for full details.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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/subuser-api-documentation/overview-1.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.