- 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. Plans are matched on your external_id: an existing one is updated, a new one is created. Synced plans are approved at once (plans made by hand in the dashboard wait for admin approval).
A plan is shown in the shop only when it is active, listed, in stock (stock above 0) and not hidden by the health check. Plans you leave out of a sync stay as they are; use Take a plan off sale to remove one.
proxy_type is free text, but the shop only understands mobile, residential, datacenter, isp, ipv6 and vpn. VLESS is proxy_type: vpn, protocol: VLESS, vpn_protocol: vless; never xray. When the proxy login fields are left out (null) on an update, the stored ones are kept.
A plan created by a sync is pinned to the key that synced it, so its orders go to that key. A sync never changes the pin of an existing plan. protocol defaults to HTTP; country and proxy_port are not validated here.
/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.
The API accepts any text, but the shop only understands these six. VLESS (Xray) plans are vpn with vpn_protocol: vless. Another value, such as xray, makes the order treat a VLESS plan as a proxy, so the customer never gets the config.
mobile, residential, datacenter, isp, ipv6, vpnProxy protocol, or the VPN protocol for vpn plans. HTTP when left out.
HTTP, SOCKS5, HTTP & SOCKS5, OpenVPN, WireGuard, VLESSDefault HTTPFull English country name, for example United States or Germany. Not validated, but the shop filter matches the names in the guide list.
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. Above 0 is needed to be shown.
Plan switched on. To be shown it must also be in stock, listed and not hidden by the health check.
truefalse keeps the plan out of every shop list (Browse and your store page).
trueOptional preset login, used as a fallback (see the provision webhook). Kept on update when null.
Optional preset proxy port. Sync does not range-check it; send 1 to 65535 (a credential push rejects anything else).
Optional preset proxy username.
Optional preset proxy password. Only what you sync is stored here: a provisioned login is not copied onto the plan, and a fallback never reuses a login that belongs to another order.
Optional URL that gives the proxy a new IP. ProxyMarket calls it with GET.
VPN plans only. vless is what lists a plan as Xray.
openvpn, wireguard, vlessVPN plans only. The full client config, given to the customer when your provision webhook fails or returns no config. 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 wrong, empty or the key is switched off: Invalid API key or Missing API key. Vendor inactive when the vendor account is disabled. A request without the header gets 422; a vendor whose application is still pending gets 403.
A plan is missing a required field or has a wrong value (for example price_usd not above 0). detail lists the fields.