Skip to content

fix(billing): update usage endpoint docs for Autumn migration #725

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
firecrawl-spring wants to merge 1 commit into from
Closed

fix(billing): update usage endpoint docs for Autumn migration #725

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion api-reference/endpoint/credit-usage-historical.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
2 changes: 1 addition & 1 deletion api-reference/endpoint/token-usage-historical.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<Info>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.</Info>

Expand Down
2 changes: 1 addition & 1 deletion api-reference/v1-endpoint/credit-usage-historical.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
2 changes: 1 addition & 1 deletion api-reference/v1-endpoint/token-usage-historical.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
12 changes: 6 additions & 6 deletions api-reference/v1-openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
}
}
Expand Down Expand Up @@ -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": [
Expand Down Expand Up @@ -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": [
Expand Down Expand Up @@ -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
}
}
Expand Down
12 changes: 6 additions & 6 deletions api-reference/v2-openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
}
}
Expand Down Expand Up @@ -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": [
Expand Down Expand Up @@ -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": [
Expand Down Expand Up @@ -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
}
}
Expand Down