BillingFrequency Property

The number of billing periods that make up one billing cycle.

Syntax

 recurringpayments.getBillingFrequency([callback])
 recurringpayments.setBillingFrequency( billingFrequency, [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 getBillingFrequency([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 setBillingFrequency([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 periods that make up one billing cycle.

The combination of BillingFrequency and BillingPeriod must be no more than one year. For example, if the BillingPeriod is Week, then the BillingFrequency must not be more than 52. Likewise, if the BillingPeriod is Month, the BillingFrequency must not be more than 12.

NOTE: If the BillingPeriod has been set to SemiMonth, the BillingFrequency must be 1.

Data Type

String