Skip to content

ScheduledChange

Source code in docs_src/capo_pricing_plan_manager/types/scheduled_change.py
class ScheduledChange(TypedDict, closed=True):
    change_type: (
        "capo_pricing_plan_manager.types.scheduled_change_type.ScheduledChangeType"
    )
    """<p>The type of pending change. Possible values are <code>DOWNGRADE</code> (a tier change to a lower level) and <code>CANCELLATION</code> (subscription termination).</p>"""
    effective_date: NotRequired["datetime.datetime"]
    """<p>The date and time when the change takes effect, in ISO 8601 format. This value is populated after the change is confirmed by the billing system.</p>"""
    plan_tier: NotRequired["str"]
    """<p>For downgrades, the tier level that the subscription will change to. Not present for cancellations.</p>"""
    usage_level: NotRequired["str"]
    """<p>For downgrades, the target usage level after the change takes effect.</p>"""

change_type instance-attribute

change_type: ScheduledChangeType

The type of pending change. Possible values are DOWNGRADE (a tier change to a lower level) and CANCELLATION (subscription termination).

effective_date instance-attribute

effective_date: NotRequired[datetime]

The date and time when the change takes effect, in ISO 8601 format. This value is populated after the change is confirmed by the billing system.

plan_tier instance-attribute

plan_tier: NotRequired[str]

For downgrades, the tier level that the subscription will change to. Not present for cancellations.

usage_level instance-attribute

usage_level: NotRequired[str]

For downgrades, the target usage level after the change takes effect.