Skip to main content
Usage planning

Soryxa Usage and Credits

Each validation request is designed to return usage fields so your application can track remaining allowance and react before a validation limit affects signup or CRM workflows.

Capacity signals

usage.remaining Alert before validation allowance reaches zero.
usage.limit Plan signup, CRM intake, and pre-send workflows from measured volume.
USAGE_LIMIT_EXCEEDED Handle as account capacity, not as an email-quality outcome.

Usage fields

usage.remaining

Number of validations remaining after the current request.

usage.limit

Plan allowance used to calculate remaining validations.

data.used

Current-period usage returned by the usage endpoint.

data.has_subscription

Whether the token team has a subscription record available for usage reporting.

data.subscription_active

Whether the subscription is active for the current usage period.

USAGE_LIMIT_EXCEEDED

Error code returned when the current plan allowance is exhausted.

Limit response

When validation allowance is exhausted, handle the usage-limit error separately from email quality.

{
  "success": false,
  "error": {
    "code": "USAGE_LIMIT_EXCEEDED",
    "message": "Validation usage limit exceeded."
  }
}

Current usage endpoint

Use GET /api/v1/usage with a token that has the usage scope to read current plan usage. The endpoint reports usage and remaining allowance without consuming a validation credit.

GET /api/v1/usage
Authorization: Bearer $SORYXA_API_KEY
Accept: application/json

Usage response

The response includes subscription state, plan name, limit, used count, remaining allowance, and current-period dates.

{
  "success": true,
  "data": {
    "has_subscription": true,
    "subscription_active": true,
    "subscription_type": "paid",
    "plan_name": "Growth",
    "limit": 10000,
    "used": 2412,
    "remaining": 7588,
    "period_started_at": "2026-06-01",
    "period_ends_at": "2026-07-01"
  }
}

Plan validation volume by workflow

Usage planning works best when each validation is tied to a specific workflow and measurable outcome.

Signup validation

Estimate one validation for each signup attempt that reaches your backend validation step.

CRM intake checks

Validate new or changed addresses before syncing them into CRM or lifecycle workflows.

Pre-send review

Run targeted checks before send-heavy workflows when address quality is uncertain.

Operational guardrails

Usage planning protects the workflow around validation. The address may be valid, invalid, or risky, but a usage-limit error only means the account needs capacity handling.

Keep usage dashboards separate from email quality dashboards. Product teams need to know why an address was allowed, blocked, or reviewed, while account owners need to know whether the current plan can support the next signup, import, or pre-send review run.

For live signup paths, review the threshold where the team should upgrade, queue validations, or temporarily change the workflow. Waiting until the first limit error appears usually creates a worse user experience than monitoring remaining allowance ahead of time.

Estimate monthly validation points

Separate signup checks, CRM intake checks, and pre-send review checks before choosing a plan. Each workflow has a different volume pattern and different urgency when allowance runs low.

Alert before exhaustion

Use remaining and limit fields to alert before validation stops. This is especially important for signup flows where a limit error can affect user onboarding.

Plan a fallback path

Decide whether over-limit requests should pause, queue, or show a controlled review state. Avoid mixing usage exhaustion with email quality decisions.