> ## Documentation Index
> Fetch the complete documentation index at: https://help.statisfy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get the renewal settings

> Which opportunities are renewals, the field that holds their amount, how the renewal forecast runs and the risks it looks for. Forecast settings and risks exist once renewal forecasting is first switched on. Read only: change them in the app.



## OpenAPI

````yaml /api/statisfy-api.openapi.json get /v1/settings/renewals
openapi: 3.1.0
info:
  description: >-
    The agent-first Statisfy API. Authenticate with an API key (`Authorization:
    Bearer stfy_live_…`), then call `GET /v1/meta/capabilities` to discover
    every operation and its schemas.
  title: Statisfy API
  version: 1.0.0
servers:
  - url: https://api.statisfy.com
    description: Production
security: []
paths:
  /v1/settings/renewals:
    get:
      tags:
        - settings
      summary: Get the renewal settings
      description: >-
        Which opportunities are renewals, the field that holds their amount, how
        the renewal forecast runs and the risks it looks for. Forecast settings
        and risks exist once renewal forecasting is first switched on. Read
        only: change them in the app.
      operationId: settings_renewals_get
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenewalSettings'
          description: Successful Response
      security:
        - HTTPBearer: []
components:
  schemas:
    RenewalSettings:
      examples:
        - amount_field: renewal_arr
          forecast:
            enabled: true
            hold_days: 30
            instructions: Treat multi-year deals as one.
            window_days: 90
          risks:
            - built_in: true
              definition: the main internal advocate has left or changed role
              name: Champion left
            - built_in: false
              definition: the customer announced a spending freeze
              name: Budget freeze
          segment:
            and:
              - field: type
                object: opportunity
                op: eq
                value: Renewal
      properties:
        amount_field:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            The opportunity field that holds the renewal amount (a /v1/fields
            key). Null: the standard amount field
          title: Amount Field
        forecast:
          anyOf:
            - $ref: '#/components/schemas/Forecast'
            - type: 'null'
          description: >-
            The renewal forecast. Null until renewal forecasting is first
            switched on
        risks:
          description: >-
            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
          items:
            $ref: '#/components/schemas/Risk'
          title: Risks
          type: array
        segment:
          anyOf:
            - $ref: '#/components/schemas/ConditionView'
            - $ref: '#/components/schemas/GroupView'
            - type: 'null'
          description: >-
            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
          title: Segment
      required:
        - segment
        - amount_field
        - forecast
        - risks
      title: RenewalSettings
      type: object
    Forecast:
      properties:
        enabled:
          description: Whether renewal forecasting is switched on
          title: Enabled
          type: boolean
        hold_days:
          anyOf:
            - type: integer
            - const: never
              type: string
          description: >-
            How many days a person's change to a forecast is kept from the AI;
            never: the AI does not overwrite a person's change
          title: Hold Days
        instructions:
          anyOf:
            - type: string
            - type: 'null'
          description: The workspace's guidance to the AI; null when none is written
          title: Instructions
        window_days:
          description: How many days before its close date a renewal is forecast
          title: Window Days
          type: integer
      required:
        - enabled
        - window_days
        - hold_days
        - instructions
      title: Forecast
      type: object
    Risk:
      properties:
        built_in:
          description: Statisfy's own risk (true) or one the workspace added (false)
          title: Built In
          type: boolean
        definition:
          description: What it means, as the AI is told
          title: Definition
          type: string
        name:
          description: The risk's name
          title: Name
          type: string
      required:
        - name
        - definition
        - built_in
      title: Risk
      type: object
    ConditionView:
      properties:
        field:
          title: Field
          type: string
        object:
          description: 'The object the field is on: account, user, opportunity, ...'
          title: Object
          type: string
        op:
          title: Op
          type: string
        value:
          title: Value
      required:
        - object
        - field
        - op
      title: ConditionView
      type: object
    GroupView:
      properties:
        and:
          anyOf:
            - items:
                anyOf:
                  - $ref: '#/components/schemas/ConditionView'
                  - $ref: '#/components/schemas/GroupView'
              type: array
            - type: 'null'
          description: All of these
          title: And
        or:
          anyOf:
            - items:
                anyOf:
                  - $ref: '#/components/schemas/ConditionView'
                  - $ref: '#/components/schemas/GroupView'
              type: array
            - type: 'null'
          description: Any of these
          title: Or
      title: GroupView
      type: object
  securitySchemes:
    HTTPBearer:
      scheme: bearer
      type: http
      description: >-
        An API key, sent as `Authorization: Bearer stfy_live_…`. See
        [Authentication](/rest-api/authentication) for how to get one and which
        scopes it needs.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.