PaymentScheduleTotalPayments Property

The total number of payments.

Syntax

 recurringbilling.getPaymentScheduleTotalPayments([callback])
 recurringbilling.setPaymentScheduleTotalPayments( paymentScheduleTotalPayments, [callback])

Default Value

0

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getPaymentScheduleTotalPayments([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setPaymentScheduleTotalPayments([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

The total number of payments. Valid values differ between gateways. See RecurringBilling Gateway Setup and Required Properties for details.

This property is not available at design time.

Data Type

Integer