Get Balance
Retrieve your prepaid OTP Verification balance and rate card.
Retrieve your prepaid OTP Verification balance and the fees you are charged for each verification.
Scope: verify.balance.read
Sample Request
curl "https://api.maileroo.com/v1/verify/balance" \
-H "Authorization: Bearer roo_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"Sample Response
Returns 200 OK. All amounts are USD decimal strings.
{
"data": {
"available": "24.500000",
"reserved": "0.300000",
"rate_card": {
"verification_fee": "0.030000",
"channel_fees": {
"email": [
{ "country": null, "min": "0.000110", "avg": "0.000110", "max": "0.000110" }
],
"sms": [
{ "country": "AU", "min": "0.022000", "avg": "0.022000", "max": "0.022000" },
{ "country": "GB", "min": "0.055000", "avg": "0.055000", "max": "0.055000" },
{ "country": "US", "min": "0.004400", "avg": "0.004400", "max": "0.004400" }
],
"voice": [
{ "country": "GB", "min": "0.006930", "avg": "0.024904", "max": "0.082610" },
{ "country": "US", "min": "0.007700", "avg": "0.007700", "max": "0.007700" }
],
"whatsapp": [
{ "country": "BR", "min": "0.007480", "avg": "0.007480", "max": "0.007480" },
{ "country": "IN", "min": "0.001540", "avg": "0.001540", "max": "0.001540" },
{ "country": null, "min": "0.033000", "avg": "0.033000", "max": "0.033000" }
],
"telegram": [
{ "country": null, "min": "0.011000", "avg": "0.011000", "max": "0.011000" }
]
}
}
}
}Response Fields
availablestringoptionalPrepaid balance you can spend on new verifications.
reservedstringoptionalAmount held for verifications whose final channel fee is not known yet. Holds are settled to the actual fee, which can take up to 48 hours.
rate_card.verification_feestringoptionalFee charged when a code is verified successfully.
rate_card.channel_feesobjectoptionalFee charged per message sent, keyed by channel (email, sms, voice, whatsapp, telegram). Each channel is a list of rows with country, min, avg, and max.
How channel fees are calculated
- Email and Telegram have one price for every country, so they have a single row with
country: nulland the samemin,avg, andmax. - WhatsApp has one row per country with its own price, followed by a
country: nullrow with the price for every other country. - SMS and voice prices vary by carrier, so each country has its own row with the lowest, average, and highest current price across carriers in that country. SMS prices are per message part. Voice prices are for one minute of a call to a standard fixed or mobile number; premium, toll-free, and other special-rate numbers are not included. US and Canada voice prices are for the mainland; calls to Alaska, Hawaii, and high-cost areas can cost more. Countries without a listed price have no row. Prices are refreshed daily.
country is an ISO 3166-1 alpha-2 code. SMS and voice prices are estimates: you are charged the actual carrier price for each message or call, which can differ by carrier, message length, and call duration.
Errors
Common authentication, rate-limit, and service-availability errors are described in the Introduction.