Tracking Costs and Usage¶
- URL: https://platform.claude.com/docs/en/agent-sdk/cost-tracking.md
- Retrieved: 2026-01-08T05:11:33.423941+00:00
Tracking Costs and Usage¶
Understand and track token usage for billing in the Claude Agent SDK
SDK Cost Tracking¶
The Claude Agent SDK provides detailed token usage information for each interaction with Claude. This guide explains how to properly track costs and understand usage reporting, especially when dealing with parallel tool uses and multi-step conversations.
For complete API documentation, see the TypeScript SDK reference.
Understanding Token Usage¶
When Claude processes requests, it reports token usage at the message level. This usage data is essential for tracking costs and billing users appropriately.
Key Concepts¶
- Steps: A step is a single request/response pair between your application and Claude
- Messages: Individual messages within a step (text, tool uses, tool results)
- Usage: Token consumption data attached to assistant messages
Usage Reporting Structure¶
Single vs Parallel Tool Use¶
When Claude executes tools, the usage reporting differs based on whether tools are executed sequentially or in parallel:
```typescript TypeScript import { query } from "@anthropic-ai/claude-agent-sdk";
// Example: Tracking usage in a conversation
const result = await query({
prompt: "Analyze this codebase and run tests",
options: {
onMessage: (message) => {
if (message.type === 'assistant' && message.usage) {
console.log(Message ID: ${message.id});
console.log(Usage:, message.usage);
}
}
}
});
```python Python
from claude_agent_sdk import query, ClaudeAgentOptions, AssistantMessage
import asyncio
# Example: Tracking usage in a conversation
async def track_usage():
# Process messages as they arrive
async for message in query(
prompt="Analyze this codebase and run tests"
):
if isinstance(message, AssistantMessage) and hasattr(message, 'usage'):
print(f"Message ID: {message.id}")
print(f"Usage: {message.usage}")
asyncio.run(track_usage())
Message Flow Example¶
Here's how messages and usage are reported in a typical multi-step conversation:
<!-- Step 1: Initial request with parallel tool uses -->
assistant (text) { id: "msg_1", usage: { output_tokens: 100, ... } }
assistant (tool_use) { id: "msg_1", usage: { output_tokens: 100, ... } }
assistant (tool_use) { id: "msg_1", usage: { output_tokens: 100, ... } }
assistant (tool_use) { id: "msg_1", usage: { output_tokens: 100, ... } }
user (tool_result)
user (tool_result)
user (tool_result)
<!-- Step 2: Follow-up response -->
assistant (text) { id: "msg_2", usage: { output_tokens: 98, ... } }
Important Usage Rules¶
1. Same ID = Same Usage¶
All messages with the same id field report identical usage. When Claude sends multiple messages in the same turn (e.g., text + tool uses), they share the same message ID and usage data.
// All these messages have the same ID and usage
const messages = [
{ type: 'assistant', id: 'msg_123', usage: { output_tokens: 100 } },
{ type: 'assistant', id: 'msg_123', usage: { output_tokens: 100 } },
{ type: 'assistant', id: 'msg_123', usage: { output_tokens: 100 } }
];
// Charge only once per unique message ID
const uniqueUsage = messages[0].usage; // Same for all messages with this ID
2. Charge Once Per Step¶
You should only charge users once per step, not for each individual message. When you see multiple assistant messages with the same ID, use the usage from any one of them.
3. Result Message Contains Cumulative Usage¶
The final result message contains the total cumulative usage from all steps in the conversation:
// Final result includes total usage
const result = await query({
prompt: "Multi-step task",
options: { /* ... */ }
});
console.log("Total usage:", result.usage);
console.log("Total cost:", result.usage.total_cost_usd);
4. Per-Model Usage Breakdown¶
The result message also includes modelUsage, which provides authoritative per-model usage data. Like total_cost_usd, this field is accurate and suitable for billing purposes. This is especially useful when using multiple models (e.g., Haiku for subagents, Opus for the main agent).
// modelUsage provides per-model breakdown
type ModelUsage = {
inputTokens: number
outputTokens: number
cacheReadInputTokens: number
cacheCreationInputTokens: number
webSearchRequests: number
costUSD: number
contextWindow: number
}
// Access from result message
const result = await query({ prompt: "..." });
// result.modelUsage is a map of model name to ModelUsage
for (const [modelName, usage] of Object.entries(result.modelUsage)) {
console.log(`${modelName}: $${usage.costUSD.toFixed(4)}`);
console.log(` Input tokens: ${usage.inputTokens}`);
console.log(` Output tokens: ${usage.outputTokens}`);
}
For the complete type definitions, see the TypeScript SDK reference.
Implementation: Cost Tracking System¶
Here's a complete example of implementing a cost tracking system:
```typescript TypeScript import { query } from "@anthropic-ai/claude-agent-sdk";
class CostTracker {
private processedMessageIds = new Set
async trackConversation(prompt: string) { const result = await query({ prompt, options: { onMessage: (message) => { this.processMessage(message); } } });
return {
result,
stepUsages: this.stepUsages,
totalCost: result.usage?.total_cost_usd || 0
};
}
private processMessage(message: any) { // Only process assistant messages with usage if (message.type !== 'assistant' || !message.usage) { return; }
// Skip if we've already processed this message ID
if (this.processedMessageIds.has(message.id)) {
return;
}
// Mark as processed and record usage
this.processedMessageIds.add(message.id);
this.stepUsages.push({
messageId: message.id,
timestamp: new Date().toISOString(),
usage: message.usage,
costUSD: this.calculateCost(message.usage)
});
}
private calculateCost(usage: any): number { // Implement your pricing calculation here // This is a simplified example const inputCost = usage.input_tokens * 0.00003; const outputCost = usage.output_tokens * 0.00015; const cacheReadCost = (usage.cache_read_input_tokens || 0) * 0.0000075;
return inputCost + outputCost + cacheReadCost;
} }
// Usage const tracker = new CostTracker(); const { result, stepUsages, totalCost } = await tracker.trackConversation( "Analyze and refactor this code" );
console.log(Steps processed: ${stepUsages.length});
console.log(Total cost: $${totalCost.toFixed(4)});
```python Python
from claude_agent_sdk import query, AssistantMessage, ResultMessage
from datetime import datetime
import asyncio
class CostTracker:
def __init__(self):
self.processed_message_ids = set()
self.step_usages =
async def track_conversation(self, prompt):
result = None
# Process messages as they arrive
async for message in query(prompt=prompt):
self.process_message(message)
# Capture the final result message
if isinstance(message, ResultMessage):
result = message
return {
"result": result,
"step_usages": self.step_usages,
"total_cost": result.total_cost_usd if result else 0
}
def process_message(self, message):
# Only process assistant messages with usage
if not isinstance(message, AssistantMessage) or not hasattr(message, 'usage'):
return
# Skip if already processed this message ID
message_id = getattr(message, 'id', None)
if not message_id or message_id in self.processed_message_ids:
return
# Mark as processed and record usage
self.processed_message_ids.add(message_id)
self.step_usages.append({
"message_id": message_id,
"timestamp": datetime.now().isoformat(),
"usage": message.usage,
"cost_usd": self.calculate_cost(message.usage)
})
def calculate_cost(self, usage):
# Implement your pricing calculation
input_cost = usage.get("input_tokens", 0) * 0.00003
output_cost = usage.get("output_tokens", 0) * 0.00015
cache_read_cost = usage.get("cache_read_input_tokens", 0) * 0.0000075
return input_cost + output_cost + cache_read_cost
# Usage
async def main():
tracker = CostTracker()
result = await tracker.track_conversation("Analyze and refactor this code")
print(f"Steps processed: {len(result['step_usages'])}")
print(f"Total cost: ${result['total_cost']:.4f}")
asyncio.run(main())
Handling Edge Cases¶
Output Token Discrepancies¶
In rare cases, you might observe different output_tokens values for messages with the same ID. When this occurs:
- Use the highest value - The final message in a group typically contains the accurate total
- Verify against total cost - The
total_cost_usdin the result message is authoritative - Report inconsistencies - File issues at the Claude Code GitHub repository
Cache Token Tracking¶
When using prompt caching, track these token types separately:
interface CacheUsage {
cache_creation_input_tokens: number;
cache_read_input_tokens: number;
cache_creation: {
ephemeral_5m_input_tokens: number;
ephemeral_1h_input_tokens: number;
};
}
Best Practices¶
- Use Message IDs for Deduplication: Always track processed message IDs to avoid double-charging
- Monitor the Result Message: The final result contains authoritative cumulative usage
- Implement Logging: Log all usage data for auditing and debugging
- Handle Failures Gracefully: Track partial usage even if a conversation fails
- Consider Streaming: For streaming responses, accumulate usage as messages arrive
Usage Fields Reference¶
Each usage object contains:
input_tokens: Base input tokens processedoutput_tokens: Tokens generated in the responsecache_creation_input_tokens: Tokens used to create cache entriescache_read_input_tokens: Tokens read from cacheservice_tier: The service tier used (e.g., "standard")total_cost_usd: Total cost in USD (only in result message)
Example: Building a Billing Dashboard¶
Here's how to aggregate usage data for a billing dashboard:
class BillingAggregator {
private userUsage = new Map<string, {
totalTokens: number;
totalCost: number;
conversations: number;
}>();
async processUserRequest(userId: string, prompt: string) {
const tracker = new CostTracker();
const { result, stepUsages, totalCost } = await tracker.trackConversation(prompt);
// Update user totals
const current = this.userUsage.get(userId) || {
totalTokens: 0,
totalCost: 0,
conversations: 0
};
const totalTokens = stepUsages.reduce((sum, step) =>
sum + step.usage.input_tokens + step.usage.output_tokens, 0
);
this.userUsage.set(userId, {
totalTokens: current.totalTokens + totalTokens,
totalCost: current.totalCost + totalCost,
conversations: current.conversations + 1
});
return result;
}
getUserBilling(userId: string) {
return this.userUsage.get(userId) || {
totalTokens: 0,
totalCost: 0,
conversations: 0
};
}
}
Related Documentation¶
- TypeScript SDK Reference - Complete API documentation
- SDK Overview - Getting started with the SDK
- SDK Permissions - Managing tool permissions