Skip to content

GetOfferOutput

Source code in docs_src/capo_marketplace_discovery/types/get_offer_output.py
class GetOfferOutput(TypedDict, closed=True):
    locale: NotRequired["capo_marketplace_discovery.types.locale.Locale"]
    """<p>The locale of the returned content. Indicates whether the response contains content in the requested locale, or fell back to the default locale. See <code>Locale</code> for details.</p>"""
    offer_id: "capo_marketplace_discovery.types.offer_id.OfferId"
    """<p>The unique identifier of the offer.</p>"""
    catalog: "capo_marketplace_discovery.types.catalog.Catalog"
    """<p>The name of the catalog that the offer belongs to.</p>"""
    offer_name: NotRequired[
        "capo_marketplace_discovery.types.nullable_string.NullableString"
    ]
    """<p>The display name of the offer. This is free-form text provided by the seller.</p>"""
    expiration_time: NotRequired["datetime.datetime"]
    """<p>The date and time until when the offer can be procured. This value is null for offers that never expire.</p>"""
    available_from_time: NotRequired["datetime.datetime"]
    """<p>The date and time when the offer became available to the buyer.</p>"""
    seller_of_record: (
        "capo_marketplace_discovery.types.seller_information.SellerInformation"
    )
    """<p>The entity responsible for selling the product under this offer.</p>"""
    associated_entities: "capo_marketplace_discovery.types.offer_associated_entity_list.OfferAssociatedEntityList"
    """<p>The products and offer sets associated with this offer.</p>"""
    agreement_proposal_id: (
        "capo_marketplace_discovery.types.agreement_resource_id.AgreementResourceId"
    )
    """<p>An encoded string to be passed by the acceptor of the terms when creating an agreement.</p>"""
    replacement_agreement_id: NotRequired[
        "capo_marketplace_discovery.types.agreement_resource_id.AgreementResourceId"
    ]
    """<p>The identifier of the existing agreement that this offer would replace. Enables agreement-based offer functionality.</p>"""
    pricing_model: "capo_marketplace_discovery.types.pricing_model.PricingModel"
    """<p>The pricing model that determines how buyers are charged, such as usage-based, contract, BYOL, or free.</p>"""
    badges: "capo_marketplace_discovery.types.purchase_option_badge_list.PurchaseOptionBadgeList"
    """<p>Badges indicating special attributes of the offer, such as private pricing, future dated, or replacement offer.</p>"""

agreement_proposal_id instance-attribute

agreement_proposal_id: AgreementResourceId

An encoded string to be passed by the acceptor of the terms when creating an agreement.

associated_entities instance-attribute

associated_entities: OfferAssociatedEntityList

The products and offer sets associated with this offer.

available_from_time instance-attribute

available_from_time: NotRequired[datetime]

The date and time when the offer became available to the buyer.

badges instance-attribute

Badges indicating special attributes of the offer, such as private pricing, future dated, or replacement offer.

catalog instance-attribute

catalog: Catalog

The name of the catalog that the offer belongs to.

expiration_time instance-attribute

expiration_time: NotRequired[datetime]

The date and time until when the offer can be procured. This value is null for offers that never expire.

locale instance-attribute

locale: NotRequired[Locale]

The locale of the returned content. Indicates whether the response contains content in the requested locale, or fell back to the default locale. See Locale for details.

offer_id instance-attribute

offer_id: OfferId

The unique identifier of the offer.

offer_name instance-attribute

offer_name: NotRequired[NullableString]

The display name of the offer. This is free-form text provided by the seller.

pricing_model instance-attribute

pricing_model: PricingModel

The pricing model that determines how buyers are charged, such as usage-based, contract, BYOL, or free.

replacement_agreement_id instance-attribute

replacement_agreement_id: NotRequired[AgreementResourceId]

The identifier of the existing agreement that this offer would replace. Enables agreement-based offer functionality.

seller_of_record instance-attribute

seller_of_record: SellerInformation

The entity responsible for selling the product under this offer.