E-Payment Integrator 2020 Node.js Edition

Questions / Feedback?

PaymentScheduleFrequencyUnit Property

The unit of time to be used when calculating the frequency of payments.

Syntax

 recurringbilling.getPaymentScheduleFrequencyUnit([callback])
 recurringbilling.setPaymentScheduleFrequencyUnit( paymentScheduleFrequencyUnit, [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 getPaymentScheduleFrequencyUnit([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 setPaymentScheduleFrequencyUnit([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 unit of time to be used when calculating the frequency of payments.

Possible values are:

  • "D" or "Days"
  • "M" or "Months"
  • "Y" or "Years"
Gateway specific values not covered by the above values may also be set. Please refer to RecurringBilling Gateway Setup and Required Properties for more information pertaining to gateway specific values.

This property is not available at design time.

Data Type

String

Copyright (c) 2021 /n software inc. - All rights reserved.
E-Payment Integrator 2020 Node.js Edition - Version 20.0 [Build 7941]