Tariffs

Last updated by FlySIP SoftSwitch on August 01, 2018 13:35

addTariff()

Parameters:

  • name - Short name of the tariff. String. Required
  • iso_4217 - currency in iso_4217 format (3 letters). Default USD. String. Optional.
  • free_seconds - free seconds of the call according to the tariff. Integer. Optional.
  • connect_fee - connect fee applied to the call according to the tariff. Double.
  • post_call_surcharge - post call surcharge applied to the call according to the tariff. Double.
  •  grace_period - grace period of the call according to the tariff. Integer.

Returns:

  • result - OK means that callback was initiated. String.
  • i_tariff - ID of the tariff. Integer.
  • XMLRPC fault in case of any error.

addBillingPlan()

Parameters:

  • prefix - rate prefix used of the call. String. Required
  • i_tariff - ID of the tariff. String. Required
  • description - Description. String. Optional.
  • i_billing_plan_suspend_mode - Billing plan suspend mode. Integer. 
  • iso_4217 - currency in iso_4217 format (3 letters). Default USD. String. Optional.
  • billing_cycle - Billing Cycle. Integer.
  • i_billing_day - Billing Day. Optional.
  • round_up - Bool. Optional. Default is false.
  • prepaid - Bool. Optional. Default is True.

Returns:

  • result - OK means that callback was initiated. String.
  • i_tariff - ID of the tariff. Integer.
  • XMLRPC fault in case of any error.

addTariffRate()

Parameters:

  • prefix - rate prefix used of the call. String. Required
  • i_tariff - ID of the tariff. String. Required
  • interval_1 - interval 1 according to the rate of the tariff. Integer.
  • interval_n - interval N according to the rate of the tariff. Integer.
  • price_1 - price 1 according to the rate of the tariff. Double.
  • price_n - price N according to the rate of the tariff. Double.
  • iso_4217 - currency in iso_4217 format (3 letters). Default USD. String. Optional.
  • activation_date - The activation date. Either dateTime.iso8601 in UTC or String in format '%H:%M:%S.000 GMT %a %b %d %Y' (e.g. 09:57:29.000 GMT Mon May 29 2017). Optional. Not NULL, if not specified, defaults to now.
  • expiration_date - The activation date. Either dateTime.iso8601 in UTC or String in format '%H:%M:%S.000 GMT %a %b %d %Y' (e.g. 13:57:29.000 GMT Mon May 29 2017). Optional. NULL value means never, if not specified, defaults to never.
  • forbidden - Bool. Optional. Default is false.
  • grace_period_enable - Bool. Optional. Default is false.

Returns:

  • result - OK means that callback was initiated. String.
  • i_tariff - ID of the tariff. Integer.
  • XMLRPC fault in case of any error.

listBillingPlans

This application is used to retrieve the list of billing plans with all parameters per each.

Returns:

  • result - OK - String.
  • list - Array of dictionaries.
  • XMLRPC fault in case of any error.

listTariffs

This application is used to retrieve the list of tariffs with all parameters per each.

Returns:

  • result - OK - String.
  • list - Array of dictionaries.
  • XMLRPC fault in case of any error.