Plans
One entry per product the account holds: for data products, how much it has been given, how much is left and where to connect; for Static ISP, how many IPs and when they renew.
List plans
/api/plansAlways an array, one entry per product the account holds; an account that has never held anything comes back as [].
curl https://birdieproxies.com/api/plans \
-H "Authorization: Bearer $BIRDIE_API_KEY"[
{
"type": "residential",
"billing": "data",
"plan_name": "Resi V1",
"data_total_gb": 50,
"data_used_gb": 12.4,
"data_remaining_gb": 37.6,
"used_last_30d_gb": 9.8,
"expires_at": null,
"status": "active",
"proxy": {
"username": "your_username",
"host": "res.birdieproxies.com",
"hard_session_host": "hard.birdieproxies.com",
"http_port": 1000,
"socks5_port": 1002
}
}
]Fields
typestring | The product, lower-case. |
billing"data" | "subscription" | How the product is charged: by the gigabyte, or monthly (Static ISP, below). |
plan_namestring | The product's display name, as the dashboard shows it. |
data_total_gbnumber | Everything ever credited to this product: purchases, free trials, referral rewards and grants. |
data_used_gbnumber | Total minus remaining. What has left the balance over the account's lifetime. |
data_remaining_gbnumber | The live balance. This is the number to alert on. |
used_last_30d_gbnumber | Bandwidth in the last 30 days, from the traffic log. Useful for a burn rate. |
expires_atnull | Data never expires, so this is always null. It is here so a client written for a subscription product needs no special case. |
status"active" | "depleted" | Active while there is data left; depleted at zero. |
proxyobject | null | Where to connect: username, host, http_port, socks5_port, and for residential hard_session_host. Null when the product has no credentials yet. The password is your proxy password from the dashboard; it is never returned here. |
How the numbers are worked out
data_remaining_gb is read live from the proxy network on every call. data_total_gb is the sum of every credit to the product from our records, and is never smaller than the remaining balance. data_used_gb is the difference. A gigabyte is 1000 MB, and all three are rounded to two decimals.
Alerting on low balance
Comparedata_remaining_gb against your own threshold, and used_last_30d_gb / 30 gives a daily burn rate to estimate days left.Static ISP
Each run of Static ISP addresses is its own entry, billed by the month with billing: "subscription". It carries an ip_count and a renews_at in place of the data totals. Treat any billing value you do not recognise as something to display rather than reject.
{
"type": "static_isp",
"billing": "subscription",
"plan_name": "Static ISP",
"ip_count": 10,
"renews_at": "2026-10-26T18:40:00.000Z",
"auto_renew": true,
"status": "active",
"proxy": {
"username": "bp1a2b3c4d5e",
"host": "203.0.113.10",
"first_port": 60010,
"last_port": 60019,
"first_ip": "198.51.100.10",
"last_ip": "198.51.100.19",
"protocols": ["http", "https"]
}
}ip_countnumber | IPs in this run. Each has its own port, from first_port to last_port, leaving from first_ip to last_ip in order. |
renews_atstring | null | The end of the month paid for. With auto_renew it is charged again then; without, the run ends then. |
auto_renewboolean | False once renewal has been switched off on the dashboard. |
status"active" | "paused" | Paused when the IPs are not being served: a renewal payment is overdue, a larger order is still being checked, or the account is suspended. |
proxyobject | null | Where to connect. The password is on the Static ISP page of the dashboard and is never returned here. |