View a markdown version of this page

Charge - AWS Marketplace

Charge

Represents a charge associated with an agreement, including amount, timing, and purchase order details.

Contents

Note

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

agreementId

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

Type: String

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

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

Required: No

agreementType

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

Type: String

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

Pattern: [A-Za-z]+

Required: No

amount

The amount of the charge.

Type: String

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

Pattern: (.)+

Required: No

currencyCode

The currency code for the charge amount.

Type: String

Length Constraints: Fixed length of 3.

Pattern: [A-Z]+

Required: No

id

The unique identifier of the charge.

Type: String

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

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

Required: No

purchaseOrderReference

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

Type: String

Length Constraints: Minimum length of 1.

Required: No

revision

The revision number of the charge.

Type: Long

Valid Range: Minimum value of 1.

Required: No

time

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

Type: Timestamp

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: