Skip to content

CancelBenefitApplicationInput

Source code in docs_src/capo_partnercentral_benefits/types/cancel_benefit_application_input.py 
14
15
16
17
18
19
20
21
22
class CancelBenefitApplicationInput(TypedDict, closed=True):
    catalog: "capo_partnercentral_benefits.types.catalog_name.CatalogName"
    """<p>The catalog identifier that specifies which benefit catalog the application belongs to.</p>"""
    client_token: "str"
    """<p>A unique, case-sensitive identifier to ensure idempotent processing of the cancellation request.</p>"""
    identifier: "capo_partnercentral_benefits.types.benefit_application_identifier.BenefitApplicationIdentifier"
    """<p>The unique identifier of the benefit application to cancel.</p>"""
    reason: NotRequired["str"]
    """<p>A descriptive reason explaining why the benefit application is being cancelled.</p>"""

catalog instance-attribute 

catalog: CatalogName

The catalog identifier that specifies which benefit catalog the application belongs to.

client_token instance-attribute 

client_token: str

A unique, case-sensitive identifier to ensure idempotent processing of the cancellation request.

identifier instance-attribute 

identifier: BenefitApplicationIdentifier

The unique identifier of the benefit application to cancel.

reason instance-attribute 

reason: NotRequired[str]

A descriptive reason explaining why the benefit application is being cancelled.