Skip to content

PaymentScheduleEntry

Source code in docs_src/capo_marketplace_agreement/types/payment_schedule_entry.py
class PaymentScheduleEntry(TypedDict, closed=True):
    charge_date_offset: NotRequired[
        "capo_marketplace_agreement.types.offset_duration.OffsetDuration"
    ]
    """<p>The time between the start date of the renewed agreement and the date this installment is charged. The duration is represented in the ISO 8601 format in either whole months or whole days (for example, <code>P1M</code> for 1 month or <code>P30D</code> for 30 days). All installments in a schedule use the same unit.</p>"""
    charge_percentage: NotRequired[
        "capo_marketplace_agreement.types.charge_percentage.ChargePercentage"
    ]
    """<p>The percentage of the total contract value of the renewed agreement that is charged in this installment. Valid values range from <code>0.01</code> to <code>100.00</code>, with up to two decimal places.</p>"""
    day_of_month: NotRequired["int"]
    """<p>The day of the month on which this installment is charged, from <code>1</code> to <code>31</code>. Use this field to anchor the charge to a specific calendar day within the month identified by <code>ChargeDateOffset</code>. This field is supported only when <code>ChargeDateOffset</code> is expressed in months.</p>"""

charge_date_offset instance-attribute

charge_date_offset: NotRequired[OffsetDuration]

The time between the start date of the renewed agreement and the date this installment is charged. The duration is represented in the ISO 8601 format in either whole months or whole days (for example, P1M for 1 month or P30D for 30 days). All installments in a schedule use the same unit.

charge_percentage instance-attribute

charge_percentage: NotRequired[ChargePercentage]

The percentage of the total contract value of the renewed agreement that is charged in this installment. Valid values range from 0.01 to 100.00, with up to two decimal places.

day_of_month instance-attribute

day_of_month: NotRequired[int]

The day of the month on which this installment is charged, from 1 to 31. Use this field to anchor the charge to a specific calendar day within the month identified by ChargeDateOffset. This field is supported only when ChargeDateOffset is expressed in months.