Product

Resources

Sign in
Optidash Blog

New API feature: Querying Account Status

Easily access your Optidash account metadata with the new Account endpoint. Get details on your plan, billing, and quota usage for efficient management.

— 1 min read

If you’d like to programatically get the metadata pertaining to your Optidash account you can now easily do so. A newly introduced /1.0/account endpoint will respond with information about your subscription such as plan level and billing period. You will also receive full information about your monthly quota consumption: total quota, used quota, and remaining quota.

Quick Example

To retrieve your account status simply send a GET request to https://api.optidash.ai/1.0/account. For example with cURL:

curl -u your-api-key: https://api.optidash.ai/1.0/account

You can expect the following response from the API:

{
    "success": true,
    "code": 200,
    "company": "Acme Inc.",
    "subscription": {
        "name": "Startup",
        "period": "Monthly"
    },
    "quota": {
        "total": 250000,
        "used": 124081,
        "remaining": 125919
    }
}

Wrapping Up

We have also updated the API documentation with this newly introduced endpoint.

Have questions about querying account status or requests for other features? Don’t hesitate to contact us anytime.