Skip to content

Charge

Source code in docs_src/capo_marketplace_agreement/types/charge.py
class Charge(TypedDict, closed=True):
    id: NotRequired["capo_marketplace_agreement.types.resource_id.ResourceId"]
    """<p>The unique identifier of the charge.</p>"""
    revision: NotRequired[
        "capo_marketplace_agreement.types.charge_revision.ChargeRevision"
    ]
    """<p>The revision number of the charge.</p>"""
    agreement_id: NotRequired["capo_marketplace_agreement.types.resource_id.ResourceId"]
    """<p>The unique identifier of the agreement that resulted in this charge.</p>"""
    agreement_type: NotRequired[
        "capo_marketplace_agreement.types.agreement_type.AgreementType"
    ]
    """<p>The type of agreement that resulted in this charge (for example, <code>PurchaseAgreement</code>).</p>"""
    purchase_order_reference: NotRequired[
        "capo_marketplace_agreement.types.purchase_order_reference.PurchaseOrderReference"
    ]
    """<p>The purchase order reference associated with the charge, if any.</p>"""
    currency_code: NotRequired[
        "capo_marketplace_agreement.types.currency_code.CurrencyCode"
    ]
    """<p>The currency code for the charge amount.</p>"""
    amount: NotRequired["capo_marketplace_agreement.types.bounded_string.BoundedString"]
    """<p>The amount of the charge.</p>"""
    time: NotRequired["capo_marketplace_agreement.types.timestamp.Timestamp"]
    """<p>The date and time when the charge will be incurred. This is available only when the charge date is known.</p>"""

agreement_id instance-attribute

agreement_id: NotRequired[ResourceId]

The unique identifier of the agreement that resulted in this charge.

agreement_type instance-attribute

agreement_type: NotRequired[AgreementType]

The type of agreement that resulted in this charge (for example, PurchaseAgreement).

amount instance-attribute

amount: NotRequired[BoundedString]

The amount of the charge.

currency_code instance-attribute

currency_code: NotRequired[CurrencyCode]

The currency code for the charge amount.

id instance-attribute

id: NotRequired[ResourceId]

The unique identifier of the charge.

purchase_order_reference instance-attribute

purchase_order_reference: NotRequired[PurchaseOrderReference]

The purchase order reference associated with the charge, if any.

revision instance-attribute

revision: NotRequired[ChargeRevision]

The revision number of the charge.

time instance-attribute

time: NotRequired[Timestamp]

The date and time when the charge will be incurred. This is available only when the charge date is known.