AgreementProperties interface

An agreement.

Properties

acceptanceMode

The mode of acceptance for an agreement. NOTE: This property will not be serialized. It can only be populated by the server.

agreementLink

The URL to download the agreement. NOTE: This property will not be serialized. It can only be populated by the server.

billingProfileInfo

The list of billing profiles associated with agreement and present only for specific agreements. NOTE: This property will not be serialized. It can only be populated by the server.

category

The category of the agreement. NOTE: This property will not be serialized. It can only be populated by the server.

displayName

The name of the agreement signed by a customer. NOTE: This property will not be serialized. It can only be populated by the server.

effectiveDate

The date from which the agreement is effective. NOTE: This property will not be serialized. It can only be populated by the server.

expirationDate

The date when the agreement expires. NOTE: This property will not be serialized. It can only be populated by the server.

leadBillingAccountName

The ID of the lead billing account if this agreement is part of the Customer Affiliate Purchase Terms. NOTE: This property will not be serialized. It can only be populated by the server.

participants

The list of participants that participates in acceptance of an agreement. NOTE: This property will not be serialized. It can only be populated by the server.

status

The current status of the agreement. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

acceptanceMode

The mode of acceptance for an agreement. NOTE: This property will not be serialized. It can only be populated by the server.

acceptanceMode?: string

Property Value

string

The URL to download the agreement. NOTE: This property will not be serialized. It can only be populated by the server.

agreementLink?: string

Property Value

string

billingProfileInfo

The list of billing profiles associated with agreement and present only for specific agreements. NOTE: This property will not be serialized. It can only be populated by the server.

billingProfileInfo?: BillingProfileInfo[]

Property Value

category

The category of the agreement. NOTE: This property will not be serialized. It can only be populated by the server.

category?: string

Property Value

string

displayName

The name of the agreement signed by a customer. NOTE: This property will not be serialized. It can only be populated by the server.

displayName?: string

Property Value

string

effectiveDate

The date from which the agreement is effective. NOTE: This property will not be serialized. It can only be populated by the server.

effectiveDate?: Date

Property Value

Date

expirationDate

The date when the agreement expires. NOTE: This property will not be serialized. It can only be populated by the server.

expirationDate?: Date

Property Value

Date

leadBillingAccountName

The ID of the lead billing account if this agreement is part of the Customer Affiliate Purchase Terms. NOTE: This property will not be serialized. It can only be populated by the server.

leadBillingAccountName?: string

Property Value

string

participants

The list of participants that participates in acceptance of an agreement. NOTE: This property will not be serialized. It can only be populated by the server.

participants?: Participant[]

Property Value

status

The current status of the agreement. NOTE: This property will not be serialized. It can only be populated by the server.

status?: string

Property Value

string