Summary

Description

Returns all service plans for client

Name

Type

Length

Required

Description

client_no

long

12

Yes

Aria-assigned unique identifier indicating the Aria client providing service to this account.

auth_key

string

32

Yes

Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.

locale_no

long

38

No

Aria-assigned unique identifier of the locale used for translations.

Alternative field: locale_name

locale_name

string

32

No

Name of the locale to which the translations belong.

Alternative field: locale_no

include_translations

string

5

No

Setting this flag as True will fetch the translated fields in all the locales defined. If not passed it defaults to False.

Allowed values:

Value	Description
True	Translated fields will be fetched in all the locales defined.
False	Translation information will not be fetched.

Name	Type	Required	Description
error_code	long	No	Aria-assigned error identifier. 0 indicates no error
error_msg	string	No	Textual description of any error that occurred. "OK" if there was no error.
plans	object	No	The plans associated with this method. See fields below
plan_translation_info	object	No	Array that contains all the translated values for a given locale. See fields below

Name	Type	Length	Required	Description
schedule_no	long	10	No	Schedule Number
client_rate_schedule_id	string	100	No	Client defined unique id for the schedule
schedule_name	string		No	Schedule Name
schedule_currency	string		No	Schedule currency
recurring_billing_interval	int		No	Recurring billing interval
recurring_billing_period_type	int	100	No	If a null/no value is provided then recurring_billing_period_type should default to 3, i.e., monthly period type. Recurring Billing Period Type [ can be either of 1, 2, 3 ] 1 – Daily, 2 – Weekly, 3 - Monthly
usage_billing_interval	int		No	Usage billing interval
usage_billing_period_type	int	100	No	If a null/no value is provided then usage_billing_period_type should default to 3, i.e., monthly period type. Usage Billing Period Type [ can be either of 1, 2, 3 ] 1 – Daily, 2 – Weekly, 3 - Monthly
default_ind	int		No	Plan default indicator
default_ind_curr	int		No	Currency default indicator

Name	Type	Length	Required	Description
plan_no	long	100	Yes	Plan Number
client_plan_id	string	100	Yes	Client defined unique identifier
plan_name	string	100	No	Plan Name
plan_level	int	1	Yes	Plan Level. [can be 0 or 1]; 0 - Master plan 1 - indicates Supplemental Plan
active_ind	int	1	Yes	Specifies if plan is active or inactive. Valid values are: 0 - Inactive 1 - Active
description	string	300	No	Plan description
is_deletable	string	100	No	Indicates if this plan is deletable. A plan is not deletable if it has an account assigned to it, or to its parent plan.
rate_sched	object		No	The rate_sched associated with this method. See fields below

Name	Type	Length	Required	Description
schedule_no	long	10	No	Schedule Number
schedule_name	string		No	Schedule Name

Name	Type	Length	Required	Description
locale_name	string	32	No	Name of the locale to which the translations belong. Alternative field: locale_no
locale_no	long	38	No	Aria-assigned unique identifier of the locale used for translations. Alternative field: locale_name
plan_no	long	100	No	Plan Number
plan_name	string	100	No	Plan Name
description	string	300	No	Specifies plan description
rate_sched_t	object		No	The rate_sched_t associated with this method. See fields below