The API reference is the source of truth for field types and examples. This page explains how the models relate.
Core model relationships
Section titled “Core model relationships”| Model | Purpose |
|---|---|
User | Authenticated account, balance, limits, discount, and preferences |
UserPreferences | Default VPN host, proxy host, and proxy protocol |
Plan | Available product with country, inventory, VPN capability, and tarifications |
PlanTarification | Duration in seconds, traffic in MB, and price in cents |
Port | Mobile proxy endpoint, status, IP, plan, access settings, and credentials |
PortPlan | The plan currently applied to one port |
PortCredentials | Source IP allowlist and login/password pairs |
GeoIP | Location and ISP data for the current port IP |
PortLog | Timestamped action, cause, source, and extra event data |
PaymentHistoryRecord | Status and account balance movement in cents |
Server | Server hostname and country code |
Error | Human-readable error message |
Important units
Section titled “Important units”- Money uses integer cents.
- Traffic uses megabytes.
- Plan duration and automatic reset intervals use seconds.
- Timestamps use RFC 3339-style strings.
- Country values are codes; preserve the value returned by the API.
Port statuses
Section titled “Port statuses”The v2 contract lists active, reset, suspended, disconnected, and outoftraffic. Clients should display unknown future statuses safely instead of failing to parse the whole port.
Identifiers and tokens
Section titled “Identifiers and tokens”A path {id} is an account-scoped port identifier. resetToken is a port reset token accepted by GET /tokens/{token}. Neither value replaces the bearer API token used for authentication.