Plans

List proxy plans

Returns active proxy plans with per-user quoted pricing. Plans without a public id are filtered out.

Without type, only mobile/GB (shared) plans are returned and the response has no next_cursor (the original response). With type, Standard dedicated plans can be included, plans come back in a stable order, and next_cursor pages through them. Premium dedicated plans are never listed.

get/proxy_plans

Request

Base URL: https://dashboard.voidmob.com/api/v1
URL: https://dashboard.voidmob.com/api/v1/proxy_plans
Auth: HTTP bearer

Query parameters

type'shared' | 'dedicated_standard' | 'all'

Plan types to list. all is shared + Standard dedicated.

countrystring

Example:us

ISO-3166-1 alpha-2 country code, lowercased. Defaults to us for SMS endpoints.

min_gbinteger

Filter to plans with at least this many GB included. Any value above 0 excludes dedicated plans.

period'daily' | 'weekly' | 'monthly'

limitinteger

availableboolean

With type, true returns only plans available right now.

cursorstring

With type, the next_cursor from the previous page.

Response

List of plans.

successtrue required

Example response

{
  "data": {
    "plans": [
      {
        "id": "plan_RESI100"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.