Properties of a Payment Agreement
Members
boolean
# allowed Optional
A flag to indicate if the merchant profile in the container allows the use of this payment agreement.
number
# chargeAmount
The amount that will be charged at the frequency specified in the payment agreement.
Date
# createdOn Optional
The timestamp for when the payment instrument was added. The timestamp format is ISO8601.
Date
# lastUpdated Optional
The timestamp the payment agreement was last updated in the container. The timestamp format is ISO8601.
Date
# lastUsed Optional
The timestamp the payment agreement was last used in the container. The timestamp format is ISO8601. Will be null if never used.
string
# paymentInstrumentId
The payment agreement payment instrument id that will be used for the charges.
string
# paymentToken Optional
The payment token of the payment agreement. The payment token is a unique identifier for the payment agreement.
boolean
# primary Optional
A flag to indicate if this payment instrument is the primary instrument in the container. Not used for payment agreements.
Date
# startDate Optional
The payment agreement start date and time. The timestamp format is ISO8601.