Skip to content

Supercharge your AI agents with data from the web and beyond. Building the library for superintelligence. 🔥

feat(billing): add jobId to BillingMetadata at all call sites (#3129)

firecrawl-spring[bot]73592ec85a9c
diff --git a/apps/api/src/controllers/v0/crawl.ts b/apps/api/src/controllers/v0/crawl.ts
index 23d00f659..70f8d990e 100644
--- a/apps/api/src/controllers/v0/crawl.ts
+++ b/apps/api/src/controllers/v0/crawl.ts
@@ -238,7 +238,7 @@ export async function crawlController(req: Request, res: Response) {
team_id,
basePriority: 21,
});
- const billing = { endpoint: "crawl" as const };
+ const billing = { endpoint: "crawl" as const, jobId: id };
const jobs = urls.map(url => {
const uuid = uuidv7();
return {
@@ -296,7 +296,7 @@ export async function crawlController(req: Request, res: Response) {
team_id,
origin: req.body.origin ?? defaultOrigin,
integration: req.body.integration,
- billing: { endpoint: "crawl" },
+ billing: { endpoint: "crawl", jobId: id },
crawl_id: id,
zeroDataRetention: false, // not supported on v0
apiKeyId: chunk?.api_key_id ?? null,
diff --git a/apps/api/src/controllers/v0/scrape.ts b/apps/api/src/controllers/v0/scrape.ts
index 8d5294e96..22e25054f 100644
--- a/apps/api/src/controllers/v0/scrape.ts
+++ b/apps/api/src/controllers/v0/scrape.ts
@@ -91,7 +91,7 @@ async function scrapeHelper(
internalOptions,
origin: req.body.origin ?? defaultOrigin,
integration: req.body.integration,
- billing: { endpoint: "scrape" },
+ billing: { endpoint: "scrape", jobId },
startTime: Date.now(),
zeroDataRetention: false, // not supported on v0
apiKeyId,
diff --git a/apps/api/src/controllers/v0/search.ts b/apps/api/src/controllers/v0/search.ts
index cfa08d1a7..d8dc46aae 100644
--- a/apps/api/src/controllers/v0/search.ts
+++ b/apps/api/src/controllers/v0/search.ts
@@ -85,7 +85,7 @@ async function searchHelper(
subscription_id,
res.length,
api_key_id,
- { endpoint: "search" },
+ { endpoint: "search", jobId },
logger,
).catch(error => {
logger.error(
@@ -106,7 +106,7 @@ async function searchHelper(
}
const jobPriority = await getJobPriority({ team_id, basePriority: 20 });
- const billing = { endpoint: "search" as const };
+ const billing = { endpoint: "search" as const, jobId };
// filter out social media links
diff --git a/apps/api/src/controllers/v1/batch-scrape.ts b/apps/api/src/controllers/v1/batch-scrape.ts
index 7a6733978..3f74fc6b3 100644
--- a/apps/api/src/controllers/v1/batch-scrape.ts
+++ b/apps/api/src/controllers/v1/batch-scrape.ts
@@ -174,7 +174,7 @@ export async function batchScrapeController(
});
}
logger.debug("Using job priority " + jobPriority, { jobPriority });
- const billing = { endpoint: "batch_scrape" as const };
+ const billing = { endpoint: "batch_scrape" as const, jobId: id };
const jobs = urls.map(x => ({
jobId: uuidv7(),
diff --git a/apps/api/src/controllers/v1/crawl.ts b/apps/api/src/controllers/v1/crawl.ts
index 180d86c42..65fdb2197 100644
--- a/apps/api/src/controllers/v1/crawl.ts
+++ b/apps/api/src/controllers/v1/crawl.ts
@@ -171,7 +171,7 @@ export async function crawlController(
internalOptions: sc.internalOptions,
origin: req.body.origin,
integration: req.body.integration,
- billing: { endpoint: "crawl" },
+ billing: { endpoint: "crawl", jobId: id },
crawl_id: id,
webhook: req.body.webhook,
v1: true,
diff --git a/apps/api/src/controllers/v1/map.ts b/apps/api/src/controllers/v1/map.ts
index 7a1fda94a..f65481e02 100644
--- a/apps/api/src/controllers/v1/map.ts
+++ b/apps/api/src/controllers/v1/map.ts
@@ -468,7 +468,7 @@ export async function mapController(
req.acuc?.sub_id,
1,
req.acuc?.api_key_id ?? null,
- { endpoint: "map" },
+ { endpoint: "map", jobId: mapId },
).catch(error => {
logger.error(
`Failed to bill team ${req.auth.team_id} for 1 credit: ${error}`,
diff --git a/apps/api/src/controllers/v1/scrape.ts b/apps/api/src/controllers/v1/scrape.ts
index e0eb6a334..e7e1d2c24 100644
--- a/apps/api/src/controllers/v1/scrape.ts
+++ b/apps/api/src/controllers/v1/scrape.ts
@@ -164,7 +164,7 @@ export async function scrapeController(
skipNuq: true,
origin,
integration: req.body.integration,
- billing: { endpoint: "scrape" },
+ billing: { endpoint: "scrape", jobId },
startTime: controllerStartTime,
zeroDataRetention: zeroDataRetention ?? false,
apiKeyId: req.acuc?.api_key_id ?? null,
diff --git a/apps/api/src/controllers/v1/search.ts b/apps/api/src/controllers/v1/search.ts
index c8f6ca9cc..d144ea7f5 100644
--- a/apps/api/src/controllers/v1/search.ts
+++ b/apps/api/src/controllers/v1/search.ts
@@ -203,7 +203,7 @@ export async function searchController(
req.acuc?.sub_id ?? undefined,
result.searchCredits,
req.acuc?.api_key_id ?? null,
- { endpoint: "search" },
+ { endpoint: "search", jobId },
).catch(error => {
logger.error(
`Failed to bill team ${req.auth.team_id} for ${result.searchCredits} credits: ${error}`,
diff --git a/apps/api/src/controllers/v2/batch-scrape.ts b/apps/api/src/controllers/v2/batch-scrape.ts
index 7dd236468..00081a516 100644
--- a/apps/api/src/controllers/v2/batch-scrape.ts
+++ b/apps/api/src/controllers/v2/batch-scrape.ts
@@ -70,8 +70,8 @@ export async function batchScrapeController(
const id = req.body.appendToId ?? uuidv7();
const billing: BillingMetadata = req.body.__agentInterop
- ? { endpoint: "agent" as const }
- : { endpoint: "batch_scrape" as const };
+ ? { endpoint: "agent" as const, jobId: id }
+ : { endpoint: "batch_scrape" as const, jobId: id };
const logger = _logger.child({
crawlId: id,
batchScrapeId: id,
diff --git a/apps/api/src/controllers/v2/browser.ts b/apps/api/src/controllers/v2/browser.ts
index ccd873b1b..eb31f506f 100644
--- a/apps/api/src/controllers/v2/browser.ts
+++ b/apps/api/src/controllers/v2/browser.ts
@@ -567,7 +567,7 @@ export async function browserDeleteController(
req.acuc?.sub_id ?? undefined,
creditsBilled,
req.acuc?.api_key_id ?? null,
- { endpoint: "browser" },
+ { endpoint: "browser", jobId: session.id },
).catch(error => {
logger.error("Failed to bill team for browser session", {
error,
@@ -694,7 +694,7 @@ export async function browserWebhookDestroyedController(
undefined, // subscription_id — billTeam will look it up
creditsBilled,
null, // api_key_id not available in webhook context
- { endpoint: "browser" },
+ { endpoint: "browser", jobId: session.id },
).catch(error => {
logger.error("Failed to bill team for browser session via webhook", {
error,
diff --git a/apps/api/src/controllers/v2/crawl.ts b/apps/api/src/controllers/v2/crawl.ts
index a00c068d3..2d0059b10 100644
--- a/apps/api/src/controllers/v2/crawl.ts
+++ b/apps/api/src/controllers/v2/crawl.ts
@@ -230,7 +230,7 @@ export async function crawlController(
internalOptions: sc.internalOptions,
origin: req.body.origin,
integration: req.body.integration,
- billing: { endpoint: "crawl" },
+ billing: { endpoint: "crawl", jobId: id },
crawl_id: id,
webhook: req.body.webhook,
v1: true,
diff --git a/apps/api/src/controllers/v2/map.ts b/apps/api/src/controllers/v2/map.ts
index d3f5ebb4f..ac88d6412 100644
--- a/apps/api/src/controllers/v2/map.ts
+++ b/apps/api/src/controllers/v2/map.ts
@@ -129,7 +129,7 @@ export async function mapController(
req.acuc?.sub_id ?? undefined,
1,
req.acuc?.api_key_id ?? null,
- { endpoint: "map" },
+ { endpoint: "map", jobId: mapId },
).catch(error => {
logger.error(
`Failed to bill team ${req.auth.team_id} for 1 credit: ${error}`,
diff --git a/apps/api/src/controllers/v2/scrape.ts b/apps/api/src/controllers/v2/scrape.ts
index a99bffc68..b03f5c036 100644
--- a/apps/api/src/controllers/v2/scrape.ts
+++ b/apps/api/src/controllers/v2/scrape.ts
@@ -85,8 +85,8 @@ export async function scrapeController(
const zeroDataRetention =
req.acuc?.flags?.forceZDR || (req.body.zeroDataRetention ?? false);
const billing: BillingMetadata = req.body.__agentInterop
- ? { endpoint: "agent" as const }
- : { endpoint: "scrape" as const };
+ ? { endpoint: "agent" as const, jobId }
+ : { endpoint: "scrape" as const, jobId };
if (
req.body.__agentInterop &&
diff --git a/apps/api/src/controllers/v2/search.ts b/apps/api/src/controllers/v2/search.ts
index 2ca239a7c..6e557c4dc 100644
--- a/apps/api/src/controllers/v2/search.ts
+++ b/apps/api/src/controllers/v2/search.ts
@@ -74,8 +74,8 @@ export async function searchController(
const shouldBill = req.body.__agentInterop?.shouldBill ?? true;
const agentRequestId = req.body.__agentInterop?.requestId ?? null;
const billing: BillingMetadata = req.body.__agentInterop
- ? { endpoint: "agent" as const }
- : { endpoint: "search" as const };
+ ? { endpoint: "agent" as const, jobId }
+ : { endpoint: "search" as const, jobId };
logger = logger.child({
version: "v2",
diff --git a/apps/api/src/lib/deep-research/deep-research-service.ts b/apps/api/src/lib/deep-research/deep-research-service.ts
index 42162478e..3c9ddadda 100644
--- a/apps/api/src/lib/deep-research/deep-research-service.ts
+++ b/apps/api/src/lib/deep-research/deep-research-service.ts
@@ -430,7 +430,7 @@ export async function performDeepResearch(options: DeepResearchServiceOptions) {
subId,
credits_billed,
apiKeyId,
- { endpoint: "deep_research" },
+ { endpoint: "deep_research", jobId: researchId },
logger,
).catch(error => {
logger.error(
diff --git a/apps/api/src/lib/extract/extraction-service.ts b/apps/api/src/lib/extract/extraction-service.ts
index e14f40cf5..fab347bba 100644
--- a/apps/api/src/lib/extract/extraction-service.ts
+++ b/apps/api/src/lib/extract/extraction-service.ts
@@ -153,7 +153,7 @@ async function performExtraction(
subId,
creditsToBill,
apiKeyId,
- { endpoint: "extract" },
+ { endpoint: "extract", jobId: extractId },
logger,
).catch(
error => {
@@ -671,7 +671,7 @@ async function performExtraction(
subId,
creditsToBill,
apiKeyId,
- { endpoint: "extract" },
+ { endpoint: "extract", jobId: extractId },
logger,
).catch(
error => {
@@ -785,7 +785,7 @@ async function performExtraction(
subId,
creditsToBill,
apiKeyId,
- { endpoint: "extract" },
+ { endpoint: "extract", jobId: extractId },
logger,
).catch(
error => {
@@ -815,7 +815,7 @@ async function performExtraction(
subId,
creditsToBill,
apiKeyId,
- { endpoint: "extract" },
+ { endpoint: "extract", jobId: extractId },
logger,
).catch(
error => {
diff --git a/apps/api/src/lib/extract/fire-0/extraction-service-f0.ts b/apps/api/src/lib/extract/fire-0/extraction-service-f0.ts
index beba75352..64dc894eb 100644
--- a/apps/api/src/lib/extract/fire-0/extraction-service-f0.ts
+++ b/apps/api/src/lib/extract/fire-0/extraction-service-f0.ts
@@ -852,7 +852,7 @@ export async function performExtraction_F0(
const creditsToBill = Math.ceil(tokensToBill / 15);
// Bill team for usage
- billTeam(teamId, subId, creditsToBill, apiKeyId, { endpoint: "extract" }, logger).catch(error => {
+ billTeam(teamId, subId, creditsToBill, apiKeyId, { endpoint: "extract", jobId: extractId }, logger).catch(error => {
logger.error(
`Failed to bill team ${teamId} for ${creditsToBill} credits: ${error}`,
);
diff --git a/apps/api/src/lib/generate-llmstxt/generate-llmstxt-service.ts b/apps/api/src/lib/generate-llmstxt/generate-llmstxt-service.ts
index c27493dc8..fc3ca92b7 100644
--- a/apps/api/src/lib/generate-llmstxt/generate-llmstxt-service.ts
+++ b/apps/api/src/lib/generate-llmstxt/generate-llmstxt-service.ts
@@ -267,7 +267,7 @@ export async function performGenerateLlmsTxt(
});
// Bill team for usage
- billTeam(teamId, subId, urls.length, apiKeyId, { endpoint: "llms_txt" }, logger).catch(error => {
+ billTeam(teamId, subId, urls.length, apiKeyId, { endpoint: "llms_txt", jobId: generationId }, logger).catch(error => {
logger.error(`Failed to bill team ${teamId} for ${urls.length} urls`, {
teamId,
count: urls.length,
diff --git a/apps/api/src/services/billing/types.ts b/apps/api/src/services/billing/types.ts
index 9a461a5f0..c318d602b 100644
--- a/apps/api/src/services/billing/types.ts
+++ b/apps/api/src/services/billing/types.ts
@@ -12,6 +12,7 @@ export type BillingEndpoint =
export type BillingMetadata = {
endpoint: BillingEndpoint;
+ jobId?: string;
};
export function resolveBillingMetadata({
@@ -39,5 +40,9 @@ export function resolveBillingMetadata({
export function toAutumnBillingProperties(
billing: BillingMetadata,
): Record<string, string> {
- return { endpoint: billing.endpoint };
+ const props: Record<string, string> = { endpoint: billing.endpoint };
+ if (billing.jobId) {
+ props.jobId = billing.jobId;
+ }
+ return props;
}