Home/Tools/@tpmjs/tools-renewal-forecast

renewalForecastTool

@tpmjs/tools-renewal-forecast

Forecasts customer renewal likelihood based on health score and engagement patterns. Provides risk assessment, positive signals, and prioritized actions to improve renewal outcomes.

Official
cx
v0.1.0
MIT
⚠️

This tool is currently broken

Execution Failed
Runtime error with test parameters
Account must have a non-empty id

Last checked: 3/1/2026, 4:27:27 AM

Interactive Playground

Test @tpmjs/tools-renewal-forecast (renewalForecastTool) with AI-powered execution

0/2000 characters

Installation & Usage

Install this tool and use it with the AI SDK

1. Install the package

npm install @tpmjs/tools-renewal-forecast
pnpm add @tpmjs/tools-renewal-forecast
yarn add @tpmjs/tools-renewal-forecast
bun add @tpmjs/tools-renewal-forecast
deno add npm:@tpmjs/tools-renewal-forecast

2. Import the tool

import { renewalForecastTool } from '@tpmjs/tools-renewal-forecast';

3. Use with AI SDK

import { generateText } from 'ai';
import { openai } from '@ai-sdk/openai';
import { renewalForecastTool } from '@tpmjs/tools-renewal-forecast';

const result = await generateText({
  model: openai('gpt-4o'),
  tools: { renewalForecastTool },
  prompt: 'Your prompt here...',
});

console.log(result.text);

Signature

(account: { id: string; name: string; tier: string; healthScore: number; renewalDate: string }) => Promise<unknown>

Tags

ai
based
churn-prediction
customer
customer-experience
customer-success
cx
engagement
forecast
forecasts
health
likelihood
patterns
provides
renewal
score
tpmjs

Parameters

Available configuration options

Auto-extracted
account
Required
Type: object

Account information for renewal forecasting

Schema extracted: 3/1/2026, 4:27:27 AM

README

ERROR: No README data found!

Statistics

Downloads/month

5

GitHub Stars

0

Quality Score

72%

Bundle Size

NPM Keywords

tpmjs
customer-experience
ai
renewal
churn-prediction
customer-success

Maintainers

thomasdavis(thomasalwyndavis@gmail.com)

Frameworks

vercel-ai
renewalForecastTool | TPMJS | TPMJS