Manipulate Low Balance

getLowBalance()

This API call is used to retrieve Low Balance information of an account or customer.

Note! Either i_account or i_customer is to be supplied.

Parameters:

i_account - i_account of account. Integer. Required.
i_customer - i_customer of customer. Integer. Required.

Returns:

result - OK. Means operation was successful. String.
threshold - Low Balance Threshold value. Double.
notify_by_email - if account/customer should be notified. Boolean.
charge_card - if account/customer should be auto-charged. Boolean.
charge_amount - amount to be charged. Double.
i_debit_credit_card - Use specified debit/credit card for auto-charging. Integer.

Next parameters are only applicable for accounts:

br_charge_card - if an account should be auto-charged on billing run. Boolean.
br_charge_amount - amount to be charged on billing run. Double.
br_i_debit_credit_card - Use specified debit/credit card for auto-charging on billing_run. Integer.
XMLRPC fault in case of other error.

setLowBalance()

This API call is used to set Low Balance parameters of an account or customer.

Note! Either i_account or i_customer is to be supplied.

Parameters:

i_account - i_account of account. Integer. Required.
i_customer - i_customer of customer. Integer. Required.
threshold - Low Balance Threshold value. Double. Optional. Null value means that threshold is disabled.
notify_by_email - if account/customer should be notified. Boolean. Optional.
charge_card - if account/customer should be auto-charged. Boolean. Optional.
charge_amount - amount to be charged. Double. Optional.
i_debit_credit_card - Use specified debit/credit card for auto-charging. Integer. Optional. Null value means to use primary debit/credit card.

Next parameters are only applicable for accounts:

br_charge_card - if an account should be auto-charged on billing run. Boolean. Optional.
br_charge_amount - amount to be charged on billing run. Double. Optional. Null value means Plan Price.
br_i_debit_credit_card - Use specified debit/credit card for auto-charging on billing_run. Integer. Optional.

Returns:

result - OK. Means that update was successful. String.
XMLRPC fault in case of other error.