Skip to documentation

Opsis API / v1

Credits & billing

Understand API balances, top-ups, and subscription fallback.

Two balances, one clear order

API searches spend prepaid API credits first. If you enable subscription-credit fallback in API settings, any remaining search cost can use your monthly plan balance. Fallback is off by default for new accounts.

ActionCredit cost
Standard search1 credit per email, username, or domain search.
Premium username search2 credits total.
Read / poll / attach streamNo additional search credits. Rate limits still apply.
Web-app searchUses subscription credits, never prepaid API credits.

An eligible Pro subscription is required for prepaid API access. Eligible Unlimited accounts already have uncapped API access and do not need to buy top-ups.

Read your available balance

GET/v1/credits
shell
curl https://api.useopsis.com/v1/credits \
  -H "Authorization: Bearer $OPSIS_API_KEY"
Illustrative Pro balance
{
  "tier": "pro",
  "credits_remaining": 138,
  "credits_used": 12,
  "credits_allowed": 150,
  "api_credits_remaining": 250,
  "use_subscription_credits": false,
  "available_api_credits": 250,
  "period_start": "2026-10-01T00:00:00Z",
  "period_end": "2026-11-01T00:00:00Z"
}

available_api_credits is the spendable API total. credits_remaining and credits_allowed refer to your subscription and can be the string "unlimited", not just numbers.

Top up without a monthly reset

Buy credits in API settings through a one-time Stripe checkout. Top-ups start at 50 credits for $20. Volume pricing scales down to $0.25 per credit at 1,000 credits ($250); larger quantities stay at $0.25 per credit. The purchase screen shows the final quote.

Prepaid credits carry over until spent. Subscription credits follow your billing period. If Pro access ends, your prepaid balance is retained, but using it requires an eligible active plan again.

Without enough API credits or enabled fallback, a new search returns 402. A negative prepaid balance after a refund must be covered before further API searches.