Skip to content

The Proxynet panel follows GitHub's organization model. An organization holds the services, the balance, the plan and the tokens together. Authorized members of the organization create and manage proxies in the panel; the API does the same work through a token.

What belongs to the organization

Services

Every proxy order is opened under the organization. GET /orders lists the organization's services.

Balance and plan

Orders are paid from the organization's balance; prices come from the organization's plan (tier).

API tokens

A token is created in one organization and sees only that organization's services.

Activity

Every change made through the API is written to the organization's Activity page.

Which organization a token belongs to

In the GET /me response, the organization field gives the organization the token belongs to, and the access field tells you what this token can see in the organization.

GET /me (shortened)
{
  "data": {
    "token": { "name": "Monitoring server", "scopes": ["orders:read"] },
    "organization": { "id": "…", "name": "Stax", "slug": "stax" },
    "access": { "order_visibility": "all", "logs": true },
    "plan": { "name": "Tier 2", "custom_credentials": true },
    "billing": { "balance": 124.5, "currency": "USD" }
  }
}
  • access.order_visibility: which of the organization's services the token can see. The list and detail endpoints apply the same visibility as the panel.
  • access.logs: whether the log endpoints are open to this token. Log access also requires your plan to include log access.

Plan and price

The plan is set at the organization level. /me, /catalog and /pricing use the same plan source, so a price quote matches the amount charged when you order. An organization with no plan assigned uses the lowest plan, and responses show price_source: base_plan.

plan.custom_credentials tells you whether you can choose the username and password yourself in an order. If not, a request that sends these fields returns 403 tier_required; if you don't send them, the values are generated for you.

More than one organization

A user can be a member of several organizations, but a token belongs to a single organization. Create a separate token for each organization, and pick the organization in your integration by choosing the token.