Skip to main content
GET
Get the renewal settings

Authorizations

Authorization
string
header
required

An API key, sent as Authorization: Bearer stfy_live_…. See Authentication for how to get one and which scopes it needs.

Response

200 - application/json

Successful Response

amount_field
string | null
required

The opportunity field that holds the renewal amount (a /v1/fields key). Null: the standard amount field

forecast
Forecast · object | null
required

The renewal forecast. Null until renewal forecasting is first switched on

risks
Risk · object[]
required

The risks the forecast looks for: Statisfy's own, less any the workspace removed, then the workspace's. Empty until renewal forecasting is first switched on

segment
ConditionView · object
required

The opportunities that are renewals: a condition on an opportunity field, or an and or or group of them, as notification rules give their conditions. Null: none chosen yet