إرسال
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

Error responses

401 Unauthorized

{ "message": "Unauthenticated." }

403 Forbidden

{ "message": "Forbidden" }

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

On this page