- API Reference
- ProxyMarket API
- Plans
Publish or update your plans
Send every product you want to sell. Call it when your connector starts and whenever a product changes. A plan whose external_id already exists is updated; a new one is created and listed at once (no admin review).
Plans you leave out are not taken off sale; use Take a plan off sale for that. For VPN products set proxy_type: vpn, put the full client file in vpn_config_template, or leave it out and deliver a config per order. For VLESS set proxy_type: vpn, protocol: VLESS and vpn_protocol: vless; never xray. Limit: 60 calls a minute.
/integration/plans/syncRequest body application/json · required
Your own unique ID for this product (a port, a modem or a VPN profile pool). Every later call and webhook uses it.
Name shown to customers.
Optional details. For VLESS, say the transport and TLS mode (for example XTLS-Reality or WS+TLS): customers filter on it.
Only these six values. VLESS (Xray) plans are vpn with vpn_protocol: vless. Any other value, such as xray, is accepted by the API but breaks the plan: orders never get their config.
mobile, residential, datacenter, isp, ipv6, vpnProxy protocol, or the VPN protocol for vpn plans.
HTTP, SOCKS5, HTTP & SOCKS5, OpenVPN, WireGuard, VLESSFull country name, for example United States or Germany. See the supported list in the guide.
Rental length, in days, or in hours when duration_unit is hours.
days, hoursDefault daysData limit in GB. null means unlimited.
Price in US dollars.
How many can be sold now. Usually 1 per modem port.
true shows the plan on the marketplace.
trueOptional preset proxy IP. You can also return it when an order is provisioned.
Optional preset proxy port.
Optional preset proxy username.
Optional preset proxy password.
Optional URL that gives the proxy a new IP.
VPN plans only. vless is what lists a plan as Xray.
openvpn, wireguard, vlessVPN plans only. The full client config, used when an order gets no config of its own. Embed certificates and keys; never a file path on your server.
Responses
What was created and what was updated, with the ProxyMarket plan_id of each.
ProxyMarket ID of the plan.
created, updatedThe X-API-Key header is missing or wrong. Check the key you saved when you created it.
A plan is missing a required field or has a wrong value. The answer names the field.
Too many calls. Wait, then retry with a growing delay.