PaymentScheduleStartDate Property

The date on which the recurring payments will start processing.

Syntax

 recurringbilling.getPaymentScheduleStartDate([callback])
 recurringbilling.setPaymentScheduleStartDate( paymentScheduleStartDate, [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 getPaymentScheduleStartDate([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 setPaymentScheduleStartDate([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 date on which the recurring payments will start processing.

This property specifies the start date. The default format is "MM/dd/yyyy" and is controlled by DateFormat, or GetSubscriptionStatus.

This property is not available at design time.

Data Type

String