Plans API
GET/plans
The plans and their limits, the WebSocket caps included, as the API enforces them, so a client never hardcodes them.
Parameters
None.
Response
| Field | Type | Meaning |
|---|---|---|
[] | array | One entry per plan: free, paid. |
name | string | The plan, as sent back in X-Aurelia-Plan. |
burstPerSecond, burstCapacity | number | The burst limit: a bucket refilling burstPerSecond a second and holding burstCapacity, so a page's first batch of requests goes through. |
freeCredits | number | On free only: the credits every account gets once. They do not renew. |
prices | array | On paid only: what credits past the free ones cost, in USD: from, the size of one deposit, and per1000, the price of 1,000 credits on a deposit that size or larger. |
minimumDeposit | number | On paid only: what deposits must total, in USD, before any of them is credited. |
live.sockets | number | /live sockets open at once, per account. |
live.subscriptions | number | Subscriptions one socket holds at once. |
live.balances | number | Of those, balances subscriptions: each reads its wallet from the chain. |
Example
Captured 2026-11-01 14:56 UTC on a test instance.
curl -s -H 'Authorization: Bearer <key>' 'https://app.aurelia.build/api/plans'[
{
"name": "free",
"burstPerSecond": 5,
"burstCapacity": 20,
"freeCredits": 10000,
"live": {
"sockets": 5,
"subscriptions": 25,
"balances": 5
}
},
{
"name": "paid",
"burstPerSecond": 30,
"burstCapacity": 120,
"prices": [
{
"from": 0,
"per1000": 0.28
},
{
"from": 280,
"per1000": 0.224
}
],
"minimumDeposit": 5,
"live": {
"sockets": 5,
"subscriptions": 100,
"balances": 10
}
}
]Notes
- Open and not metered.
- See Authentication and limits for who gets which plan, and the socket for what the caps count.