GET /account
GET /account
Section titled “GET /account”Which account a key acts for, and what it has left to send with. Use it to show “connected as” in an integration, to check a freshly pasted key, and to warn before credits run out.
| Scope | any |
| Auth | Authorization: Bearer mk_live_… |
curl https://app.maukirim.com/api/v1/account -H "Authorization: Bearer mk_live_…"Response
Section titled “Response”200
{ "ok": true, "account": { "id": "usr_…", "name": "Toko Kopi", "email": "owner@example.com", "currency": "IDR" }, "balance": { "credits": 125000, "currency": "IDR" }, "plan": { "id": "pkg_…", "name": "Notification Starter", "includedMessages": 1000, "overageRate": 28 }, "usage": { "otp": 12, "notification": 340 }, "quota": { "notification": { "included": 1000, "used": 340, "remaining": 660, "resetsAt": "2026-11-01T00:00:00.000Z" } }, "scopes": ["notification"]}| Field | Meaning |
|---|---|
balance.credits |
Prepaid credits; one credit is one rupiah |
plan |
The package the account pays for, or null |
usage |
The account’s OTP and notification sends |
quota.notification |
The plan’s notification messages this calendar month (UTC): spent before credits, so a send costs nothing while remaining is above zero. null when the plan does not include notifications |
scopes |
What this key may call |
Errors
Section titled “Errors”401 for a missing, unknown, revoked or expired key; 403 forbidden when the account is not active; 500.