PaymentScheduleFrequency Property
The frequency of payments.
Syntax
recurringbilling.getPaymentScheduleFrequency([callback]) recurringbilling.setPaymentScheduleFrequency( paymentScheduleFrequency, [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 getPaymentScheduleFrequency([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 setPaymentScheduleFrequency([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 of payments.
Possible values are:
- "None"
- "Daily"
- "Weekly"
- "BiWeekly"
- "FourWeeks"
- "SemiMonthly"
- "Monthly"
- "BiMonthly"
- "Quarterly"
- "SemiAnnually"
- "Annually"
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.
If PaymentScheduleFrequencyUnit is applicable to the gateway, this property specifies the length of time between charges. This is used in combination with PaymentScheduleFrequencyUnit to specify the frequency of the billing. For instance if PaymentScheduleFrequencyUnit is set to "Days" and PaymentScheduleFrequency is set to "5", payments will occur every 5 days.
This property is not available at design time.
Data Type
String