IPMusk Plans API
The Plans API from IPMusk — 1 operation(s) for plans.
The Plans API from IPMusk — 1 operation(s) for plans.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/ipmusk-com:ipmusk-com-plans-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: IPMusk Customer Plans API
version: 1.0.0
description: 'Read the catalogue, get residential and static proxy credentials, check usage and orders, and handle support tickets. Authenticate with an API key from the dashboard (Settings > API keys) sent as `Authorization: Bearer `; each key carries the scopes read, connect and/or support. Rate limits per key and minute: read 60, connect 20, support 30 (429 rate_limited, with a Retry-After header in seconds). JSON responses are `{ data, request_id }`; errors are `{ error: { code, message, field_errors? }, request_id }`. Money is amount_minor (minor units) with an ISO 4217 currency.'
servers:
- url: https://ipmusk.com
tags:
- name: Plans
paths:
/api/v1/plans:
get:
operationId: plans_list
summary: List plans with prices
description: Plans that can be quoted right now. Residential plans carry their one-time and subscription prices; static plans carry a price per IP for each term and the place's stock. Filter with product, and with category for static plans.
parameters:
- name: product
in: query
required: false
description: Only this product's plans.
schema:
description: Only this product's plans.
type: string
enum:
- rotating_residential
- static_isp
- name: category
in: query
required: false
description: Only static plans of this kind.
schema:
description: Only static plans of this kind.
type: string
enum:
- native_isp
- isp
- datacenter
- residential
responses:
'200':
description: List plans with prices
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
items:
type: array
items:
oneOf:
- type: object
properties:
product_id:
type: string
const: rotating_residential
plan_id:
type: string
minLength: 1
maxLength: 128
name:
type: string
traffic_gb:
type: number
exclusiveMinimum: 0
prices:
type: array
items:
type: object
properties:
price_option_id:
type: string
minLength: 1
maxLength: 128
billing_mode:
type: string
enum:
- one_time
- subscription
billing_interval:
anyOf:
- type: string
const: month
- type: 'null'
amount_minor:
type: integer
minimum: 0
maximum: 9007199254740991
unit_amount_minor:
type: integer
minimum: 0
maximum: 9007199254740991
currency:
type: string
pattern: ^[A-Z]{3}$
required:
- price_option_id
- billing_mode
- billing_interval
- amount_minor
- unit_amount_minor
- currency
additionalProperties: false
required:
- product_id
- plan_id
- name
- traffic_gb
- prices
additionalProperties: false
- type: object
properties:
product_id:
type: string
const: static_isp
plan_id:
type: string
minLength: 1
maxLength: 128
name:
type: string
category:
type: string
enum:
- native_isp
- isp
- datacenter
- residential
country_code:
type: string
pattern: ^[A-Z]{2}$
location_name:
type: string
subdivision_name:
anyOf:
- type: string
- type: 'null'
prices:
type: array
items:
type: object
properties:
resource_days:
type: integer
exclusiveMinimum: 0
maximum: 9007199254740991
amount_minor:
type: integer
minimum: 0
maximum: 9007199254740991
currency:
type: string
pattern: ^[A-Z]{3}$
required:
- resource_days
- amount_minor
- currency
additionalProperties: false
stock:
anyOf:
- type: object
properties:
available:
type: integer
minimum: 0
maximum: 9007199254740991
sold_out:
type: boolean
paused:
type: boolean
synced_at:
anyOf:
- type: string
format: date-time
pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
- type: 'null'
required:
- available
- sold_out
- paused
- synced_at
additionalProperties: false
- type: 'null'
required:
- product_id
- plan_id
- name
- category
- country_code
- location_name
- subdivision_name
- prices
- stock
additionalProperties: false
required:
- items
additionalProperties: false
request_id:
type: string
minLength: 8
maxLength: 128
required:
- data
- request_id
additionalProperties: false
default:
$ref: '#/components/responses/Error'
tags:
- Plans
components:
responses:
Error:
description: 'Any failure: 400 validation_error, 401 authentication_required, 403 forbidden / capability_unavailable, 404 not_found, 409 invalid_state_transition / idempotency_conflict, 422 product_unavailable, 429 rate_limited, 500 internal_error.'
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
schemas:
ErrorEnvelope:
type: object
properties:
error:
type: object
properties:
code:
type: string
enum:
- validation_error
- authentication_required
- region_blocked
- forbidden
- not_found
- idempotency_conflict
- invalid_state_transition
- checkout_unavailable
- product_unavailable
- capability_unavailable
- rate_limited
- challenge_required
- upstream_unavailable
- internal_error
message:
type: string
minLength: 1
maxLength: 500
field_errors:
type: object
propertyNames:
type: string
additionalProperties:
type: array
items:
type: string
minLength: 1
maxLength: 300
required:
- code
- message
additionalProperties: false
request_id:
type: string
minLength: 8
maxLength: 128
required:
- error
- request_id
additionalProperties: false
securitySchemes:
bearerAuth:
type: http
scheme: bearer
description: An IPMusk API key (ipm_live_…).