View Credit Usage Stats

Endpoint essentials
API key accessapi/v1/usage_stats/credit_usage_stats or Master API key
OAuth scopescredit_usage_stats_read
Credit usage0 credits
Learn more about API pricing and credits.

Use the View Credit Usage Stats endpoint to monitor your team's credit balance across every credit type in the current billing cycle.

For each credit type, the response returns the limit (your team's allowance for the cycle), consumed (credits used so far), and left_over (credits remaining). The current_credit_cycle object reports the start and end dates of the billing cycle these stats cover.

Balances reflect your team's running credit usage and update within seconds of a credit-consuming request. To retrieve credit usage for a single user instead of the whole team, use Get Current User Profile with the include_credit_usage query parameter set to true.

Credit types

The credit_usage_stats object is keyed by credit type. Each key funds a different Apollo action:

KeyWhat it funds
lead_creditEmail address reveals and email enrichment.
direct_dial_creditMobile and direct dial phone number reveals.
export_creditCSV exports of contacts and accounts.
conversation_creditConversation intelligence and call recording.
ai_creditAI-generated email writing.
power_up_creditAI power-up field enrichment on contact and account records.
inbound_website_visitor_creditInbound website visitor identification.
contact_website_visitor_creditContact-level website visit tracking.
web_search_record_creditWeb search enrichment records.
dialerDialer talk time. Reported in minutes, not credits.

A credit type your Apollo plan doesn't include returns a limit of 0.

If your team is on a unified credit plan, lead_credit is a shared pool: the left_over value already accounts for mobile reveals, exports, dialer minutes, and power-up enrichment, so don't add the individual balances together to estimate what's left.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/plain