2013

Name-Value Pair API Developer Guide February 01, 2013 151
Recurring Payments and Reference Transactions API Operations
GetRecurringPaymentsProfileDetails API Operation
12
Recurring Payments Summary Details Fields
REGULARTAXAMT Tax amount for each billing cycle during this regular payment period.
NOTE: All amounts in the request must have the same currency.
Character length and limitations: Value is a positive number which cannot exceed
$10,000 USD in any currency. It includes no currency symbol. It must have 2 decimal
places, the decimal separator must be a period (.), and the optional thousands
separator must be a comma (,).
This field is available since version 53.0.
CURRENCYCODE (Required) Currency code (default is USD).
Character length and limitations: 3 single-byte characters
REGULARCURRENCYCODE (Required) Currency code (default is USD).
This field is available since version 53.0.
Field Description
NEXTBILLINGDATE The next scheduled billing date, in YYYY-MM-DD format.
NUMCYLESCOMPLETED The number of billing cycles completed in the current active subscription period. A
billing cycle is considered completed when payment is collected or after retry
attempts to collect payment for the current billing cycle have failed.
NUMCYCLESREMAINING The number of billing cycles remaining in the current active subscription period.
OUTSTANDINGBALANCE The current past due or outstanding balance for this profile.
Character length and limitations: Does not exceed $10,000 USD in any currency. No
currency symbol. Regardless of currency, decimal separator is a period (.), and the
optional thousands separator is a comma (,). Equivalent to nine characters maximum
for USD.
FAILEDPAYMENTCOUNT The total number of failed billing cycles for this profile.
LASTPAYMENTDATE The date of the last successful payment received for this profile, in YYYY-MM-DD
format.
LASTPAYMENTAMT The amount of the last successful payment received for this profile.
Character length and limitations: Does not exceed $10,000 USD in any currency. No
currency symbol. Regardless of currency, decimal separator is a period (.), and the
optional thousands separator is a comma (,). Equivalent to nine characters maximum
for USD.
Field Description