BillingTaxAmount Property

The tax amount associated with each billing cycle.

Syntax

 recurringpayments.getBillingTaxAmount([callback])
 recurringpayments.setBillingTaxAmount( billingTaxAmount, [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 getBillingTaxAmount([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 setBillingTaxAmount([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 tax amount associated with each billing cycle.

This value must not exceed $10,000 USD in any currency.

It will also not contain any currency symbols, must have two decimal places separated by a period (.), and optionally a comma (,) separating the thousands digits.

Data Type

String