BillingTotalCycles Property

The number of billing cycles for the payment period.

Syntax

 recurringpayments.getBillingTotalCycles([callback])
 recurringpayments.setBillingTotalCycles( billingTotalCycles, [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 getBillingTotalCycles([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 setBillingTotalCycles([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 number of billing cycles for the payment period.

A billing cycle is specified by the combination of the BillingPeriod and the BillingFrequency properties. A billing cycle may not exceed one year.

If this property is not specified or set to zero, PayPal will continue billing this profile until it is cancelled or deactivated.

Data Type

String