Account

The Account API lets you programmatically fetch information about your Clearout account, including profile details, current subscription or pay-as-you-go plans, remaining credits and limits.

Get Plans and Addons

get

Retrieve details about the account's active subscription plan and any associated add-ons, including pricing and upcoming billing renewal cycles

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successfully retrieved plan and addon information

application/json

Success response containing plan details

statusstringRequired

Response status

Example: success

401

Unauthorized - Invalid or missing authentication credentials

application/json

503

Service Unavailable - Server is temporarily unavailable

get/account/myplans

GET /v2/account/myplans HTTP/1.1
Host: api.clearout.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "status": "success",
  "data": {
    "current_plan": {
      "name": "starter-3000-credits",
      "status": "active",
      "type": "subscription",
      "charge": "$18/month",
      "next_credit_allocation": "Transition to standard ISO 8601 format (e.g., \"2026-01-29T12:45:20Z\").",
      "next_charge_renewal": "Transition to standard ISO 8601 format (e.g., \"2026-01-29T12:45:20Z\")."
    },
    "addons": [
      {
        "name": "email-verify-api-rate-limit",
        "status": "active",
        "type": "subscription",
        "charge": "$99 for additional 100 RPM",
        "next_charge_renewal": "Transition to standard ISO 8601 format (e.g., \"2026/01/30 17:45:20Z\")."
      }
    ]
  }
}

Get Remaining Credits

get

Retrieve the total remaining credit balance along with a categorized breakdown (subscription, pay-as-you-go, and bonus credits) for both individual and organization accounts.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successfully retrieved credits information

application/json

Success response containing credits data

statusstringRequired

Response status

Example: success

401

Unauthorized - Invalid or missing authentication credentials

application/json

503

Service Unavailable - Server is temporarily unavailable

get/account/credits

GET /v2/account/credits HTTP/1.1
Host: api.clearout.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "status": "success",
  "data": {
    "total_remaining_credits": 6000,
    "plan_remaining_credits": {
      "pay-as-you-go": 1000,
      "subscription": 5000,
      "bonus": 0
    },
    "low_credit_balance_min_threshold": 50
  }
}

Get Service Limits

get

Retrieve the account's active rate limits (Requests Per Minute) and parallel processing constraints for both real-time and bulk verification services.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successfully retrieved service limits

application/json

Success response containing limits data

statusstringRequired

Response status

Example: success

401

Unauthorized - Invalid or missing authentication credentials

application/json

503

Service Unavailable - Server is temporarily unavailable

get/account/limits

GET /v2/account/limits HTTP/1.1
Host: api.clearout.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "status": "success",
  "data": {
    "email_verify": {
      "api_rate_limit": {
        "total": "200 RPM",
        "remaining": "40 RPM",
        "next_limit_reset": "Transition to standard ISO 8601 format (e.g., \"2026/01/30 17:45:20Z\")."
      },
      "bulk_verify_concurrency_limit": {
        "total": "3 parallel bulk allowed",
        "remaining": "2 parallel bulk allowed"
      }
    }
  }
}