On this page
No Headings
The agreement details.
objectcycles_remainingstringThe number of payment cycles remaining for this agreement.
cycles_completedstringThe number of payment cycles completed for this agreement.
next_billing_datestringThe next billing date and time for this agreement, in Internet date and time format. For example, 2017-01-23T08:00:00Z.
last_payment_datestringThe last payment date and time for this agreement, in Internet date and time format. For example, 2016-12-23T08:00:00Z.
final_payment_datestringThe final payment date and time for this agreement, in Internet date and time format. For example, 2017-09-23T08:00:00Z.
failed_payment_countstringThe total number of failed payments for this agreement.
outstanding_balanceobjectThe currency and amount of the outstanding balance for this agreement.
The currency and amount for a transaction.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The currency value. Might be an integer for currencies like JPY that are not typically fractional or a three-place decimal fraction for currencies like TND that are subdivided into thousandths. For the required number of decimal places for a currency code, see Currency codes - ISO 4217.
currencyrequiredobjectppaas_common_currency_code_v2The three-character ISO-4217 currency code that identifies the currency.
last_payment_amountobjectThe currency and amount of the last payment amount for this agreement.
The currency and amount for a transaction.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The currency value. Might be an integer for currencies like JPY that are not typically fractional or a three-place decimal fraction for currencies like TND that are subdivided into thousandths. For the required number of decimal places for a currency code, see Currency codes - ISO 4217.
currencyrequiredobjectppaas_common_currency_code_v2The three-character ISO-4217 currency code that identifies the currency.