Orders
Every purchase on the account, newest first, with what it cost, any discount, and when it was paid and credited. One order can be fetched by id.
List orders
GET
/api/orders?limit=50&status=creditedlimitinteger, 1 to 200 | How many to return. Default 50, newest first. |
statusstring | Only orders in one status: pending, paid, credited, refunded or failed. Omit for all. |
curl https://birdieproxies.com/api/orders?limit=2 \
-H "Authorization: Bearer $BIRDIE_API_KEY"200 OK
[
{
"id": "cmg1x9k2s0001abcd",
"type": "residential",
"gb": 20,
"ips": 0,
"amount_pence": 2880,
"currency": "GBP",
"discount_pence": 1920,
"status": "credited",
"created_at": "2026-09-20T13:17:40.000Z",
"paid_at": "2026-09-20T13:19:02.000Z",
"credited_at": "2026-09-20T13:19:03.000Z",
"receipt_url": "https://pay.stripe.com/receipts/..."
},
{
"id": "cmfz8p1r70001wxyz",
"type": "residential",
"gb": 10,
"ips": 0,
"amount_pence": 2400,
"currency": "GBP",
"discount_pence": 0,
"status": "credited",
"created_at": "2026-09-16T09:02:15.000Z",
"paid_at": "2026-09-16T09:03:48.000Z",
"credited_at": "2026-09-16T09:03:49.000Z",
"receipt_url": null
}
]Get one order
GET
/api/orders/{id}The same shape as one element of the list. An id that is not on this account is a 404, never a hint that it exists elsewhere.
curl https://birdieproxies.com/api/orders/cmg1x9k2s0001abcd \
-H "Authorization: Bearer $BIRDIE_API_KEY"Fields
idstring | Stable order id. The same one shown on receipts and in support. |
typestring | The product bought, as on plans. |
gbinteger | Gigabytes bought. Zero on a Static ISP order. |
ipsinteger | IPs paid for on a Static ISP order (type: "static_isp"); zero on a data order. Each monthly renewal is its own order. |
amount_penceinteger | What was charged before tax, after any discount, in minor units. Divide by 100. |
currencystring | ISO 4217, upper-case. GBP today. |
discount_penceinteger | What a code or the VIP discount took off. Zero when none applied. |
statusstring | See statuses below. |
created_atISO 8601 | When checkout started. |
paid_atISO 8601 | null | When the payment settled. |
credited_atISO 8601 | null | When the data landed on the balance. Normally within a second of paid_at. |
receipt_urlstring | null | The hosted receipt, when the payment processor issued one. |
Statuses
pending | Checkout was started and not finished. These expire on their own within half an hour. |
paid | Money received; data on its way. A rare in-between state, and one the operator is alerted to if it lasts. |
credited | Done: the data is on the balance. This is the status to count as a sale. |
refunded | Refunded in full or part after payment. |
failed | Checkout was abandoned, expired or refused. |
Totals
To total what an account has spent, sumamount_pence over credited and paid orders and ignore the rest.