AgreementViewSummary

A summary of the agreement, including top-level attributes (for example, the agreement ID, proposer, and acceptor).

Note

In the following list, the required parameters are described first.

acceptanceTime

The date and time that the agreement was accepted.

Type: Timestamp

Required: No

acceptor

Details of the party accepting the agreement terms. This is commonly the buyer for PurchaseAgreement.

Type: Acceptor object

Required: No

agreementId

The unique identifier of the agreement.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [A-Za-z0-9_/-]+

Required: No

agreementType

The type of agreement.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [A-Za-z]+

Required: No

endTime

The date and time when the agreement ends. The field is null for pay-as-you-go agreements, which don’t have end dates.

Type: Timestamp

Required: No

endTimeBehaviorReasonCode

The reason why the agreement doesn't renew at its end date. The field is null when the agreement renews.

More than one reason can apply to the same agreement. When that happens, the operation returns only one reason code, and PROPOSER_RENEW_OPTED_OUT takes precedence over all others.

The EnableAutoRenew field reflects only the acceptor's preference, and doesn't reflect the other reasons an agreement might not renew.

Reason codes include:

PROPOSER_RENEW_OPTED_OUT – The proposer opted out of renewing the agreement.
ACCEPTOR_RENEW_OPTED_OUT – The acceptor opted out of renewing the agreement.
NO_RENEWAL_TERM – The accepted terms of the agreement don't include a renewal term, which is required for an agreement to renew.
RENEWAL_LIMIT_EXHAUSTED – The agreement reached the maximum number of renewals allowed by its renewal term.

Type: String

Valid Values: PROPOSER_RENEW_OPTED_OUT | ACCEPTOR_RENEW_OPTED_OUT | NO_RENEWAL_TERM | RENEWAL_LIMIT_EXHAUSTED

Required: No

endTimeBehaviorType

The behavior of the agreement when it reaches its end date. The field is null for agreements that have no end date, because those agreements never reach an end time.

Types include:

RENEW – A new agreement is created from the accepted terms of this agreement.
REPLACE – A new agreement is created from a different offer than the one this agreement was created from. This happens, for example, when a private offer reaches its end date and the acceptor transitions to the public offer for the product.
EXPIRE – The agreement ends and isn't renewed or replaced.

Type: String

Valid Values: RENEW | REPLACE | EXPIRE

Required: No

entitlements

A list of entitlements associated with the agreement.

Type: Array of Entitlement objects

Required: No

initialAgreementId

The unique identifier of the very first agreement in a chain of related agreements, such as renewals or replacements. It stays the same across all agreements in that chain, which lets you trace an agreement back to the original. You can also use it as the InitialAgreementId filter value to return every agreement in the same chain.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [A-Za-z0-9_/-]+

Required: No

lastUpdateTime

The date and time when the agreement was last updated. An agreement is updated when any of its attributes or accepted terms change. Amendments, renewals, and a party changing whether the agreement renews are all examples.

Use the BeforeLastUpdateTime and AfterLastUpdateTime filters to search on this value, and LastUpdateTime as the SortBy value to sort by it. Sorting by LastUpdateTime is supported only when PartyType is Proposer.

Type: Timestamp

Required: No

proposalSummary

A summary of the proposal

Type: ProposalSummary object

Required: No

proposer

Details of the party proposing the agreement terms, most commonly the seller for PurchaseAgreement.

Type: Proposer object

Required: No

startTime

The date and time when the agreement starts.

Type: Timestamp

Required: No

status

The current status of the agreement.

Type: String

Required: No

AgreementViewSummary

Contents

Note

See Also