Skip to content

RenewalTerm

Source code in docs_src/capo_marketplace_discovery/types/renewal_term.py
class RenewalTerm(TypedDict, closed=True):
    id: "capo_marketplace_discovery.types.term_id.TermId"
    """<p>The unique identifier of the term.</p>"""
    type: "capo_marketplace_discovery.types.term_type.TermType"
    """<p>The category of the term.</p>"""
    max_renewals: NotRequired["int"]
    """<p>The maximum number of renewals allowed on this offer. Absent means unlimited renewals.</p>"""
    lockout_period: NotRequired[
        "capo_marketplace_discovery.types.bounded_string.BoundedString"
    ]
    """<p>The duration before the agreement end date when the lockout window begins, in ISO 8601 format (for example, P30D). Absent means no lockout.</p>"""
    adjustment_deadline: NotRequired[
        "capo_marketplace_discovery.types.bounded_string.BoundedString"
    ]
    """<p>The duration before the agreement end date by which the renewal price is finalized, represented in ISO 8601 format (for example, P30D). Only applicable with <code>PercentageRange</code>.</p>"""
    price_increase: NotRequired[
        "capo_marketplace_discovery.types.price_increase.PriceIncrease"
    ]
    """<p>The price increase applied at each renewal cycle. Absent means identical pricing on renewal.</p>"""
    term_templates: NotRequired[
        "capo_marketplace_discovery.types.term_template_list.TermTemplateList"
    ]
    """<p>Structural templates defining how specific terms are reshaped on each renewal cycle. Absent for upfront-only offers.</p>"""

adjustment_deadline instance-attribute

adjustment_deadline: NotRequired[BoundedString]

The duration before the agreement end date by which the renewal price is finalized, represented in ISO 8601 format (for example, P30D). Only applicable with PercentageRange.

id instance-attribute

id: TermId

The unique identifier of the term.

lockout_period instance-attribute

lockout_period: NotRequired[BoundedString]

The duration before the agreement end date when the lockout window begins, in ISO 8601 format (for example, P30D). Absent means no lockout.

max_renewals instance-attribute

max_renewals: NotRequired[int]

The maximum number of renewals allowed on this offer. Absent means unlimited renewals.

price_increase instance-attribute

price_increase: NotRequired[PriceIncrease]

The price increase applied at each renewal cycle. Absent means identical pricing on renewal.

term_templates instance-attribute

term_templates: NotRequired[TermTemplateList]

Structural templates defining how specific terms are reshaped on each renewal cycle. Absent for upfront-only offers.

type instance-attribute

type: TermType

The category of the term.