Skip to content

Get a renewals summary

Tool name: get_renewals_summary

Returns how many customers are due to renew in a period, and the total ARR renewing in the organization’s currency, across the member’s customers. Both dates are included in the period.

Input schema

fromDatestringrequired
Any of:

The first day of the period, such as 2025-01-01

string (date)
toDatestringrequired
Any of:

The last day of the period, such as 2025-03-31

string (date)
scopestring

mine: customers the member is assigned to. team: customers the member or their team is assigned to. all: every customer the member can see

Default:"mine"
Enum:"mine""team""all"
Input example
{ "fromDate": "2019-08-24", "toDate": "2019-08-24", "scope": "mine" }