Account Information API

This endpoint allows you to retrieve information about the current user's usage, remaining credits, current plan, and next quota renewal date.

ℹ️

This endpoint is free to use.

Endpoint

POST https://api.prospeo.io/account-information

curl -X POST \
 -H "Content-Type: application/json" \
 -H "X-KEY: your_api_key" \
 "https://api.prospeo.io/account-information"

Parameters

This endpoint does not require any parameters.

Response

A successful request will return the following information:

{
    "error": false,
    "response": {
        "current_plan": "STARTER",
        "remaining_credits": 999,
        "used_credits": 1,
        "next_quota_renewal_days": 25,
        "next_quota_renewal_date": "2023-06-18 20:52:28+00:00"
    }
}
PropertyTypeDescription
current_planstringThe current plan you are subscribed to.
remaining_creditsintegerThe number of credits remaining.
used_creditsintegerThe number of credits already used.
next_quota_renewal_daysintegerThe number of days until the next quota renewal.
next_quota_renewal_datestringThe date and time of the next quota renewal.
ℹ️

If you need further assistance, feel free to contact us at [email protected].