AutoBill Property

Whether PayPal should automatically bill the outstanding balance in the next billing cycle.

Syntax

 recurringpayments.getAutoBill([callback])
 recurringpayments.setAutoBill( autoBill, [callback])

Default Value

FALSE

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 getAutoBill([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 setAutoBill([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

This property is used when CreateProfile or UpdateProfile is called to tell PayPal to automatically bill the outstanding balance in the next billing cycle. The outstanding balance is any amount from a previously scheduled payment that has not yet been paid.

This property will be populated after a call to GetProfile.

Data Type

Boolean