API ReferenceLinks API
Account
Read your plan limits and current usage - /v1/account.
Read the authenticated account's tier, plan limits and this month's usage. Useful for showing quota in your own UI or deciding when to prompt an upgrade.
Get account
GET https://links.esmsafrica.io/v1/accountResponse - 200
{
"user_id": "f798d18e-a923-4af8-8306-0db9db77e0a6",
"email": "[email protected]",
"tier": "business",
"is_admin": false,
"plan": {
"tier": "business",
"price_usd": 15,
"monthly_links": 5000,
"monthly_qr": 300,
"api_monthly": 50000,
"max_domains": 1,
"max_team": 5,
"analytics_days": 365,
"has_branded_domains": true,
"has_country_device_analytics": true,
"has_webhooks": true,
"has_sms_integration": true
},
"usage": {
"links_this_month": 214,
"qr_this_month": 12
}
}| Field | Description |
|---|---|
tier | free, starter, business, professional or enterprise |
plan | The full plan limit set (abridged above). -1 means unlimited. |
usage.links_this_month | Short links created this calendar month |
usage.qr_this_month | QR codes created this calendar month |
Limits reset at the start of each calendar month (UTC). Existing links keep working and tracking clicks even after you reach your monthly creation limit.