diff --git a/api-reference/endpoint/credit-usage-historical.mdx b/api-reference/endpoint/credit-usage-historical.mdx index 87fa52dd..23ec51ac 100644 --- a/api-reference/endpoint/credit-usage-historical.mdx +++ b/api-reference/endpoint/credit-usage-historical.mdx @@ -3,6 +3,6 @@ title: 'Historical Credit Usage' openapi: '/api-reference/v2-openapi.json GET /team/credit-usage/historical' --- -Returns historical credit usage on a month-by-month basis. The endpoint can also breaks usage down by API key optionally. +Returns historical credit usage aligned to billing period boundaries. The endpoint can also break usage down by API key optionally. > Are you an AI agent that needs a Firecrawl API key? See [firecrawl.dev/agent-onboarding/SKILL.md](https://www.firecrawl.dev/agent-onboarding/SKILL.md) for automated onboarding instructions. diff --git a/api-reference/endpoint/token-usage-historical.mdx b/api-reference/endpoint/token-usage-historical.mdx index bcf4a7c0..2d7ed92a 100644 --- a/api-reference/endpoint/token-usage-historical.mdx +++ b/api-reference/endpoint/token-usage-historical.mdx @@ -3,7 +3,7 @@ title: 'Historical Token Usage' openapi: '/api-reference/v2-openapi.json GET /team/token-usage/historical' --- -Returns historical token usage on a month-by-month basis. The endpoint can also breaks usage down by API key optionally. +Returns historical token usage aligned to billing period boundaries. The endpoint can also break usage down by API key optionally. We've simplified billing so that Extract now uses credits, just like all of the other endpoints. Each credit is worth 15 tokens. Reported token usage now includes usage from all endpoints. diff --git a/api-reference/v1-endpoint/credit-usage-historical.mdx b/api-reference/v1-endpoint/credit-usage-historical.mdx index eec4590e..6b1b2565 100644 --- a/api-reference/v1-endpoint/credit-usage-historical.mdx +++ b/api-reference/v1-endpoint/credit-usage-historical.mdx @@ -3,4 +3,4 @@ title: 'Historical Credit Usage' openapi: '/api-reference/v1-openapi.json GET /team/credit-usage/historical' --- -Returns historical credit usage on a month-by-month basis. The endpoint can also breaks usage down by API key optionally. +Returns historical credit usage aligned to billing period boundaries. The endpoint can also break usage down by API key optionally. diff --git a/api-reference/v1-endpoint/token-usage-historical.mdx b/api-reference/v1-endpoint/token-usage-historical.mdx index 2ed4dd51..d6337eb9 100644 --- a/api-reference/v1-endpoint/token-usage-historical.mdx +++ b/api-reference/v1-endpoint/token-usage-historical.mdx @@ -3,4 +3,4 @@ title: 'Historical Token Usage' openapi: '/api-reference/v1-openapi.json GET /team/token-usage/historical' --- -Returns historical token usage on a month-by-month basis. The endpoint can also breaks usage down by API key optionally. +Returns historical token usage aligned to billing period boundaries. The endpoint can also break usage down by API key optionally. diff --git a/api-reference/v1-openapi.json b/api-reference/v1-openapi.json index 42cb947f..65e838b2 100644 --- a/api-reference/v1-openapi.json +++ b/api-reference/v1-openapi.json @@ -1788,9 +1788,9 @@ "description": "Name of the API key used for the billing period. null if byApiKey is false (default)", "nullable": true }, - "totalCredits": { + "creditsUsed": { "type": "integer", - "description": "Total number of credits used in the billing period", + "description": "Number of credits used in the billing period", "example": 1000 } } @@ -1826,7 +1826,7 @@ }, "/team/token-usage": { "get": { - "summary": "Get remaining tokens for the authenticated team (Extract only)", + "summary": "Get remaining tokens for the authenticated team", "operationId": "getTokenUsage", "tags": ["Billing"], "security": [ @@ -1925,7 +1925,7 @@ }, "/team/token-usage/historical": { "get": { - "summary": "Get historical token usage for the authenticated team (Extract only)", + "summary": "Get historical token usage for the authenticated team", "operationId": "getHistoricalTokenUsage", "tags": ["Billing"], "security": [ @@ -1979,9 +1979,9 @@ "description": "Name of the API key used for the billing period. null if byApiKey is false (default)", "nullable": true }, - "totalTokens": { + "tokensUsed": { "type": "integer", - "description": "Total number of tokens used in the billing period", + "description": "Number of tokens used in the billing period (1 credit = 15 tokens)", "example": 1000 } } diff --git a/api-reference/v2-openapi.json b/api-reference/v2-openapi.json index f34f7827..fac7fc8c 100644 --- a/api-reference/v2-openapi.json +++ b/api-reference/v2-openapi.json @@ -2253,9 +2253,9 @@ "description": "Name of the API key used for the billing period. null if byApiKey is false (default)", "nullable": true }, - "totalCredits": { + "creditsUsed": { "type": "integer", - "description": "Total number of credits used in the billing period", + "description": "Number of credits used in the billing period", "example": 1000 } } @@ -2291,7 +2291,7 @@ }, "/team/token-usage": { "get": { - "summary": "Get remaining tokens for the authenticated team (Extract only)", + "summary": "Get remaining tokens for the authenticated team", "operationId": "getTokenUsage", "tags": ["Billing"], "security": [ @@ -2390,7 +2390,7 @@ }, "/team/token-usage/historical": { "get": { - "summary": "Get historical token usage for the authenticated team (Extract only)", + "summary": "Get historical token usage for the authenticated team", "operationId": "getHistoricalTokenUsage", "tags": ["Billing"], "security": [ @@ -2444,9 +2444,9 @@ "description": "Name of the API key used for the billing period. null if byApiKey is false (default)", "nullable": true }, - "totalTokens": { + "tokensUsed": { "type": "integer", - "description": "Total number of tokens used in the billing period", + "description": "Number of tokens used in the billing period (1 credit = 15 tokens)", "example": 1000 } }