Skip to main content
MailInsightX Developers

Getting Started

API Reference

Changelog

Last updated September 10, 2026

GET /v1/balance

Returns your account's current credit balance and subscription status.

Request

GET /v1/balance HTTP/1.1
Host: mailinsightx.com
x-api-key: mi_your_api_key

No parameters.

Response

{
  "credits": 8420,
  "insightx_credits": 312,
  "plan": "business",
  "subscription": {
    "plan_id": "business",
    "billing_cycle": "monthly",
    "status": "active",
    "current_period_end": "2026-10-01T00:00:00.000Z"
  }
}

subscription is null if your account has no subscription record on file.

Tip

This endpoint reflects the same monthly-reset logic as the dashboard - if you call it right after your billing cycle resets, you'll see the fresh balance, not a stale pre-reset value.

Errors

Status Meaning
404 { "error": "User not found" } - an edge case; your account row couldn't be found despite valid authentication.
500 { "error": "Internal server error" }

Also see the common authentication and rate-limit errors.