AdditionalBillingCycles Property

The number of additional billing cycles for PayPal to add to the current profile.

Syntax

 recurringpayments.getAdditionalBillingCycles([callback])
 recurringpayments.setAdditionalBillingCycles( additionalBillingCycles, [callback])

Default Value

""

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 getAdditionalBillingCycles([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 setAdditionalBillingCycles([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

Use this property when calling UpdateProfile to add additional billing cycles to the number of CyclesRemaining.

Data Type

String