Documentation

The Credit Usage API allows you to retrieve information about your current subscription plan and credit consumption. This endpoint is useful for monitoring usage, enforcing limits, and displaying account status in dashboards or internal tools.

Description

This endpoint returns details about your active plan, including total available credits, credits consumed, remaining credits, and plan status.

Authentication

This API requires authentication. Include your API key in the request headers as per standard VehicleDatabases authentication requirements.

GET https://api.vehicledatabases.com/info
Headers: x-authkey: YOUR_API_KEY

{
    "PlanType": "Subscription",
    "PlanName": "Starter",
    "TotalCredits": 5500,
    "CreditsUsed": 1145,
    "CreditsLeft": 4355,
    "CreditsOverage": 0,
    "OverageCharges": "$0.00",
    "AdditionalInfo": {
        "LastPayment": "2025-12-26",
        "NextBilling": "2026-01-26",
        "Status": "Active"
    }
}