BillingStartDate Property

Set this property to the date at which billing should begin for the current profile.

Syntax

 recurringpayments.getBillingStartDate([callback])
 recurringpayments.setBillingStartDate( billingStartDate, [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 getBillingStartDate([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 setBillingStartDate([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

Set this property to the date at which billing should begin for the current profile.

This property must be a valid date in UTC/GMT format.

NOTE: It may take up to 24 hours for the profile to be activated.

The date and time must be in the following format:

"yyyy-MM-ddTHH:mm:ss.fffZ".

This is explained in more detail below:

For instance, "2004-05-26T15:00:00.000Z" is May 26th, 2004 at 3:00pm GMT.

Data Type

String