Skip to content

PricingPlan

Source code in docs_src/capo_billing/types/pricing_plan.py
class PricingPlan(TypedDict, closed=True):
    pricing_plan_id: NotRequired["str"]
    """<p>The unique identifier for the pricing plan.</p>"""
    name: NotRequired["str"]
    """<p>The name of the pricing plan.</p>"""
    description: NotRequired["str"]
    """<p>A description of the pricing plan.</p>"""
    start_date: NotRequired["datetime.datetime"]
    """<p>The start date of the pricing plan.</p>"""
    end_date: NotRequired["datetime.datetime"]
    """<p>The end date of the pricing plan.</p>"""
    plan_discount_percent: NotRequired["str"]
    """<p>The discount percentage applied by this pricing plan.</p>"""
    discount_applies_to_minimum_charge: NotRequired["bool"]
    """<p>Whether the discount applies to the minimum Support charge.</p>"""
    minimum_charge: NotRequired["str"]
    """<p>The minimum Support charge amount for this pricing plan.</p>"""
    tiered: NotRequired["str"]
    """<p>Whether the pricing plan uses tiered pricing.</p>"""
    tiers: "capo_billing.types.pricing_plan_tier_list.PricingPlanTierList"
    """<p>The pricing tiers within this plan.</p>"""

description instance-attribute

description: NotRequired[str]

A description of the pricing plan.

discount_applies_to_minimum_charge instance-attribute

discount_applies_to_minimum_charge: NotRequired[bool]

Whether the discount applies to the minimum Support charge.

end_date instance-attribute

end_date: NotRequired[datetime]

The end date of the pricing plan.

minimum_charge instance-attribute

minimum_charge: NotRequired[str]

The minimum Support charge amount for this pricing plan.

name instance-attribute

name: NotRequired[str]

The name of the pricing plan.

plan_discount_percent instance-attribute

plan_discount_percent: NotRequired[str]

The discount percentage applied by this pricing plan.

pricing_plan_id instance-attribute

pricing_plan_id: NotRequired[str]

The unique identifier for the pricing plan.

start_date instance-attribute

start_date: NotRequired[datetime]

The start date of the pricing plan.

tiered instance-attribute

tiered: NotRequired[str]

Whether the pricing plan uses tiered pricing.

tiers instance-attribute

The pricing tiers within this plan.