E-Payment Integrator V6 - Online Help
E-Payment Integrator V6
Questions / Feedback?

SubscriptionDetailsFrequency Property

The frequency in which payments will occur.

Syntax

 recurringbilling.getSubscriptionDetailsFrequency([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 getSubscriptionDetailsFrequency([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 setSubscriptionDetailsFrequency([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 frequency in which payments will occur.

If SubscriptionDetailsFrequencyUnit is applicable, this property will contain the length of the corresponding SubscriptionDetailsFrequencyUnit in which payments will occur.

This component uses pre-defined Frequency values which are listed below. If a gateway returns any value not contained within the pre-defined list, the raw value will be returned.

  • None
  • Daily
  • Weekly
  • BiWeekly
  • FourWeeks
  • SemiMonthly
  • Monthly
  • BiMonthly
  • Quarterly
  • SemiAnnually
  • Annually

This property is read-only and not available at design time.

Data Type

String

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Build 6.0.6240.0