API Reference
Dashboard
  1. API Reference
  2. ProxyMarket API
  3. 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.

  • Action · reversible
  • Vendor API key (X-API-Key)
  • syncPlans
POST/integration/plans/sync

Request body application/json · required

[].external_idstringrequired

Your own unique ID for this product (a port, a modem or a VPN profile pool). Every later call and webhook uses it.

[].namestringrequired

Name shown to customers.

[].descriptionstringoptional

Optional details. For VLESS, say the transport and TLS mode (for example XTLS-Reality or WS+TLS): customers filter on it.

[].proxy_typestringrequired

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.

One of mobile, residential, datacenter, isp, ipv6, vpn
[].protocolstringrequired

Proxy protocol, or the VPN protocol for vpn plans.

One of HTTP, SOCKS5, HTTP & SOCKS5, OpenVPN, WireGuard, VLESS
[].countrystringrequired

Full country name, for example United States or Germany. See the supported list in the guide.

[].duration_daysintegerrequired

Rental length, in days, or in hours when duration_unit is hours.

[].duration_unitstringoptional
One of days, hoursDefault days
[].bandwidth_gbnumber | nulloptional

Data limit in GB. null means unlimited.

[].price_usdnumberrequired

Price in US dollars.

[].stockintegerrequired

How many can be sold now. Usually 1 per modem port.

[].is_activebooleanoptional

true shows the plan on the marketplace.

Default true
[].proxy_ipstringoptional

Optional preset proxy IP. You can also return it when an order is provisioned.

[].proxy_portintegeroptional

Optional preset proxy port.

[].proxy_usernamestringoptional

Optional preset proxy username.

[].proxy_passwordstringoptional

Optional preset proxy password.

[].rotation_linkstringoptional

Optional URL that gives the proxy a new IP.

[].vpn_protocolstringoptional

VPN plans only. vless is what lists a plan as Xray.

One of openvpn, wireguard, vless
[].vpn_config_templatestringoptional

VPN 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.

createdintegeroptional
updatedintegeroptional
plansobject[]optional
plans[].plan_idstringoptional

ProxyMarket ID of the plan.

plans[].external_idstringoptional
plans[].statusstringoptional
One of created, updated
Verified against ProxyMarket vendor guide v1.11 on Nov 20, 2026