RenewalTerm ¶

class RenewalTerm(TypedDict, closed=True):
    type: NotRequired[
        "capo_marketplace_agreement.types.unversioned_term_type.UnversionedTermType"
    ]
    """<p>Category of the term being updated. </p>"""
    id: NotRequired["capo_marketplace_agreement.types.term_id.TermId"]
    """<p>The unique identifier for the term.</p>"""
    configuration: NotRequired[
        "capo_marketplace_agreement.types.renewal_term_configuration.RenewalTermConfiguration"
    ]
    """<p>Additional parameters specified by the acceptor while accepting the term.</p>"""
    lockout_period: NotRequired[
        "capo_marketplace_agreement.types.day_duration.DayDuration"
    ]
    """<p>The renewal decision deadline, measured back from the end date of the agreement. This is the last day either party can opt in to or opt out of the renewal. The duration is represented in the ISO 8601 format in whole days (for example, <code>P30D</code> for 30 days or <code>P60D</code> for 60 days).</p> <p>The field is <code>null</code> when no renewal decision deadline is set. In that case, either party can change the auto-renewal decision up to the end date of the agreement.</p>"""
    max_renewals: NotRequired["int"]
    """<p>The maximum number of times the agreement can be renewed. The field is <code>null</code> when the number of renewals is unlimited.</p> <p>After the agreement reaches this limit, it expires on its end date instead of renewing.</p>"""
    adjustment_deadline: NotRequired[
        "capo_marketplace_agreement.types.day_duration.DayDuration"
    ]
    """<p>The date by which the proposer must finalize the price increase for the next renewal, measured back from the end date of the agreement. The duration is represented in the ISO 8601 format in whole days (for example, <code>P30D</code> for 30 days or <code>P60D</code> for 60 days).</p> <p>This field applies only when <code>PriceIncrease</code> is a <code>PercentageRange</code>. The field is <code>null</code> when <code>PriceIncrease</code> is a <code>FixedPercentage</code>, because the price increase is already fixed and there is nothing for the proposer to finalize. If the proposer doesn't finalize a value by the adjustment deadline, the <code>DefaultValue</code> of the range applies.</p> <p> <code>AdjustmentDeadline</code> must be greater than <code>LockoutPeriod</code>.</p>"""
    price_increase: NotRequired[
        "capo_marketplace_agreement.types.price_increase.PriceIncrease"
    ]
    """<p>The price increase that is applied each time the agreement renews. The field is <code>null</code> when the price doesn't change at renewal.</p>"""
    term_templates: NotRequired[
        "capo_marketplace_agreement.types.term_template_list.TermTemplateList"
    ]
    """<p>Defines how specific terms change each time the agreement renews. The field is <code>null</code> when no terms change at renewal.</p>"""