إرسال
Project

Get Project Balance

Check the current SMS and OTP balance and limits for the project

Endpoint

GET /api/project/balance

Example

curl https://sms.lamah.com/api/project/balance \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Response

{
  "SMS": { "balance": 500, "limit": 500 },
  "OTP": { "balance": 200, "limit": 200 }
}
FieldTypeDescription
SMS.balancenumberRemaining SMS credits available
SMS.limitnumberSMS plan limit
OTP.balancenumberRemaining OTP credits available
OTP.limitnumberOTP plan limit

These figures cover subscription quota only. A project with no active subscription reports 0 across the board — that does not mean it cannot send, since payment_type: "wallet" draws on the company wallet instead. Wallet balance is not exposed through this endpoint.

Error responses

401 Unauthorized

{ "message": "Invalid or missing token." }
{ "message": "Unauthorized IP address." }

Use this endpoint to check available quota before sending bulk messages or to display remaining quota to your users.

On this page