BillingPeriod Property

This property contains the unit for billing during the billing cycle.

Syntax

 recurringpayments.getBillingPeriod([callback])
 recurringpayments.setBillingPeriod( billingPeriod, [callback])

Possible Values

  0 (bpDay), 
  1 (bpWeek), 
  2 (bpSemiMonth), 
  3 (bpMonth), 
  4 (bpYear)

Default Value

0

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 getBillingPeriod([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 setBillingPeriod([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 contains the unit for billing during the billing cycle.

Possible values include:

If SemiMonth is specified, billing will be done on the first and fifteenth of each month.

Data Type

Integer