BillOutstandingAmount Method

This method will bill the outstanding amount.

Syntax

recurringpayments.billOutstandingAmount(profileId, amount, [callback])

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 this 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

Use this method to tell PayPal to bill the outstanding amount for the recurring payments profile. This method takes a ProfileId parameter which specifies the profile to be billed. It also takes an optional Amount parameter which tells PayPal how much of the outstanding amount to bill the customer. If no amount is specified, PayPal will attempt to bill the full OutstandingBalance.

An optional Note may be attached to the request to PayPal.