> For the complete documentation index, see [llms.txt](https://docs.clearout.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.clearout.io/developers/api/account.md).

# 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

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

```json
{"openapi":"3.0.2","info":{"title":"Clearout OpenAPI","version":"1.1"},"tags":[{"name":"Account","description":"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."}],"servers":[{"url":"https://api.clearout.io/v2"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"MyPlansDataType":{"type":"object","description":"User's current plan and addons information","required":["current_plan","addons"],"properties":{"current_plan":{"$ref":"#/components/schemas/PlanType"},"addons":{"type":"array","description":"List of active addons for the account","items":{"$ref":"#/components/schemas/AddonType"}}}},"PlanType":{"type":"object","description":"Plan information for the current subscription","required":["name","status","type","charge"],"properties":{"name":{"type":"string","description":"Name of the plan"},"status":{"type":"string","description":"Current status of the plan","enum":["active","inactive","suspended"]},"type":{"type":"string","description":"Type of the plan","enum":["subscription","one-time"]},"charge":{"type":"string","description":"Charge information for the plan"},"next_credit_allocation":{"type":"string","format":"date-time","description":"Date when next credits will be allocated"},"next_charge_renewal":{"type":"string","format":"date-time","description":"Date of the next charge renewal"}}},"AddonType":{"type":"object","description":"Addon subscription details","required":["name","status","type"],"properties":{"name":{"type":"string","description":"Name of the addon"},"status":{"type":"string","description":"Current status of the addon","enum":["active","inactive","suspended"]},"type":{"type":"string","description":"Type of the addon","enum":["subscription","one-time"]},"charge":{"type":"string","description":"Charge information for the addon"},"next_charge_renewal":{"type":"string","format":"date-time","description":"Date of the next charge renewal"}}},"GetCreditsUnauthorizedResponseType":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"}}}}},"paths":{"/account/myplans":{"get":{"tags":["Account"],"summary":"Get Plans and Addons","description":"Retrieve details about the account's active subscription plan and any associated add-ons, including pricing and upcoming billing renewal cycles","operationId":"getMyPlans","responses":{"200":{"description":"Successfully retrieved plan and addon information","content":{"application/json":{"schema":{"type":"object","description":"Success response containing plan details","required":["status","data"],"properties":{"status":{"type":"string","description":"Response status"},"data":{"$ref":"#/components/schemas/MyPlansDataType"}}}}}},"401":{"description":"Unauthorized - Invalid or missing authentication credentials","content":{"application/json":{"schema":{"type":"object","description":"Unauthorized error response","properties":{"status":{"type":"string","description":"Response Object Status"},"error":{"$ref":"#/components/schemas/GetCreditsUnauthorizedResponseType"}}}}}},"503":{"description":"Service Unavailable - Server is temporarily unavailable"}}}}}}
```

## Get Remaining Credits

> 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.

```json
{"openapi":"3.0.2","info":{"title":"Clearout OpenAPI","version":"1.1"},"tags":[{"name":"Account","description":"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."}],"servers":[{"url":"https://api.clearout.io/v2"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"CreditsDataType":{"type":"object","properties":{"total_remaining_credits":{"type":"integer","description":"Total credits available in the account"},"plan_remaining_credits":{"type":"object","description":"Remaining credits split by plan type","properties":{"pay-as-you-go":{"type":"integer"},"subscription":{"type":"integer"},"bonus":{"type":"integer"}}},"low_credit_balance_min_threshold":{"type":"integer","description":"Minimum threshold to trigger low credit alert"}}},"GetCreditsUnauthorizedResponseType":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"}}}}},"paths":{"/account/credits":{"get":{"tags":["Account"],"summary":"Get Remaining Credits","description":"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.","operationId":"getCredits","responses":{"200":{"description":"Successfully retrieved credits information","content":{"application/json":{"schema":{"type":"object","description":"Success response containing credits data","required":["status","data"],"properties":{"status":{"type":"string","description":"Response status"},"data":{"$ref":"#/components/schemas/CreditsDataType"}}}}}},"401":{"description":"Unauthorized - Invalid or missing authentication credentials","content":{"application/json":{"schema":{"type":"object","description":"Unauthorized error response","properties":{"status":{"type":"string","description":"Response status"},"error":{"$ref":"#/components/schemas/GetCreditsUnauthorizedResponseType"}}}}}},"503":{"description":"Service Unavailable - Server is temporarily unavailable"}}}}}}
```

## Get Service Limits

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

```json
{"openapi":"3.0.2","info":{"title":"Clearout OpenAPI","version":"1.1"},"tags":[{"name":"Account","description":"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."}],"servers":[{"url":"https://api.clearout.io/v2"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"LimitsDataType":{"type":"object","description":"Account service limits and concurrency restrictions","required":["email_verify"],"properties":{"email_verify":{"$ref":"#/components/schemas/EmailVerifyLimitsType"}}},"EmailVerifyLimitsType":{"type":"object","description":"Service-specific limits for email verify API","required":["api_rate_limit"],"properties":{"api_rate_limit":{"$ref":"#/components/schemas/ApiRateLimitType"},"bulk_verify_concurrency_limit":{"$ref":"#/components/schemas/ConcurrencyLimitType"}}},"ApiRateLimitType":{"type":"object","description":"API rate limit information for a specific service","required":["total","remaining"],"properties":{"total":{"type":"string","description":"Total API rate limit"},"remaining":{"type":"string","description":"Remaining API rate limit"},"next_limit_reset":{"type":"string","format":"date-time","description":"Timestamp when the rate limit resets"}}},"ConcurrencyLimitType":{"type":"object","description":"Concurrency limit information for bulk operations","required":["total","remaining"],"properties":{"total":{"type":"string","description":"Total concurrency limit"},"remaining":{"type":"string","description":"Remaining concurrency limit"}}},"GetCreditsUnauthorizedResponseType":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"}}}}},"paths":{"/account/limits":{"get":{"tags":["Account"],"summary":"Get Service Limits","description":"Retrieve the account's active rate limits (Requests Per Minute) and parallel processing constraints for both real-time and bulk verification services.","operationId":"getAccountLimits","responses":{"200":{"description":"Successfully retrieved service limits","content":{"application/json":{"schema":{"type":"object","description":"Success response containing limits data","required":["status","data"],"properties":{"status":{"type":"string","description":"Response status"},"data":{"$ref":"#/components/schemas/LimitsDataType"}}}}}},"401":{"description":"Unauthorized - Invalid or missing authentication credentials","content":{"application/json":{"schema":{"type":"object","description":"Unauthorized error response","properties":{"status":{"type":"string","description":"Response status"},"error":{"$ref":"#/components/schemas/GetCreditsUnauthorizedResponseType"}}}}}},"503":{"description":"Service Unavailable - Server is temporarily unavailable"}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.clearout.io/developers/api/account.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.