InitialAmount Property

The amount due at the creation of the profile.

Syntax

 recurringpayments.getInitialAmount([callback])
 recurringpayments.setInitialAmount( initialAmount, [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 getInitialAmount([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 setInitialAmount([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

Use this property when CreateProfile is called to set an initial non-recurring amount that will be due for the profile.

NOTE: Use this property to specify enrollment or set up fees.

Data Type

String