Home > Aria6 User Documentation > Aria6 core api > get_client_plans_all

get_client_plans_all

Returns a detailed list of all plans associated with a client. If you do not filter the call by acct_no, the information returned includes the services and service rate associated with the plans. If you filter the call by acct_no, the information returned does not include any master plan service or rate schedule details.

Input Arguments

Req Field Name Field Type Max Length Description
required-icon.png client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
required-icon.png auth_key string 32 Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.
  plan_no long   Aria-assigned plan identifier. This value is unique across all Aria-managed accounts.
  OR      
  client_plan_id string 100 Client-defined Plan ID for which to query available child plans
  acct_no long 38 Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
  promo_code string 30 This is the code provided the client and used by the account holder during registration or when executing a transaction. A promotion generally provides access to a custom set of reduced-rate plans.
  parent_plan_no long   Aria-assigned unique plan identifier for the parent plan
  OR      
  client_parent_plan_id string 100 Client-defined unique parent Plan ID
  brd_arrow.gifsupp_field_names string array 300 An array of client-specified supplemental field names
  brd_arrow.gifsupp_field_values string array 1000 An array of client-specified supplemental field values corresponding to the names above
  include_all_rate_schedules string 5 If set to "true", will retrieve all of the rates and rate schedules associated with a particular plan. If left blank, will default to "false".  

Allowable values for include_all_rate_schedules

Values Description
true true
false false
  include_plan_hierarchy string 5 You can use this input parameter to specify whether to retrieve the child plans associated with the returned plans or with the plan_no or parent_plan_no that you specified. If you set the include_plan_hierarchy parameter to true , then all of the child plans down to the bottom level of your plan hierarchy will be returned.  

Allowable values for include_plan_hierarchy

Values Description
true true
false false
 

Output Arguments

Field Name Field Type Description
error_code long Aria-assigned error identifier. 0 indicates no error.
error_msg string Description of any error that occurred. "OK" if there was no error.
all_client_plans hash A multidimensional array containing all client plans.
brd_arrow.gif plan_no long Aria-assigned unique plan identifier
brd_arrow.gif plan_name string Plan Name
brd_arrow.gif plan_desc string Text description of this plan
brd_arrow.gif supp_plan_ind long Indicates whether or not this plan is a supplemental plan. 

Allowable values for supp_plan_ind

Values Description
0 0
1 1
brd_arrow.gif billing_interval long Number of months between billing cycles
brd_arrow.gif billing_ind long Indicates whether or not this plan is billable 

Allowable values for billing_ind

Values Description
0 0
1 1
brd_arrow.gif display_ind long Indicates whether or not the plan is marked as "displayable". 0 means not displayable. 1 means displayable. 

Allowable values for display_ind

Values Description
0 0
1 1
brd_arrow.gif rollover_months long Number of months in which the account will change from the current plan to the pre-defined rollover plan.
brd_arrow.gif rollover_plan_no long Pre-defined plan to which the account will change based on the defined rollover_months value; the rollover record is created when an account is placed on a plan with a defined rollover plan.
brd_arrow.gif early_cancel_fee double Fee charged for early cancellations.
brd_arrow.gif early_cancel_min_months long Number of months during which early cancellation fees would apply on plan cancellation.
brd_arrow.gif suspension_period long Pre-defined period in days in which an account will degrade to Suspended status (-1) if action is not taken such as a plan or status change.
brd_arrow.gif new_acct_status long The status code to assert for the new account. 

Allowable values for new_acct_status

Values Description
0 INACTIVE
1 ACTIVE
2 CANCELLATION PENDING
3 TERMINATION PENDING
10 ACTIVE DUNNING PENDING
11 ACTIVE DUNNING 1
12 ACTIVE DUNNING 1
13 ACTIVE DUNNING 3
14 ACTIVE DUNNING 4
15 ACTIVE DUNNING 5
16 ACTIVE DUNNING 6
17 ACTIVE DUNNING 7
18 ACTIVE DUNNING 8
21 REINSTATED FORWARD BILL
22 REINSTATED BACK BILL
31 INSTALLATION PENDING
32 REGISTERED PENDING ACTIVATION
41 ACTIVE TRIAL
51 TEMPORARY SERVICE BAN
61 ACTIVE NON-BILLABLE
99 PERMANENT
-1 SUSPENDED
-2 CANCELLED
-3 TERMINATED
-4 CONTRACT EXPIRED
-11 SUSPENDED DUNNING 1
-12 SUSPENDED DUNNING 2
-13 SUSPENDED DUNNING 3
-14 SUSPENDED DUNNING 4
-15 SUSPENDED DUNNING 5
-99 ARCHIVED
brd_arrow.gif rollover_acct_status long Default status for new accounts created on this plan. 

Allowable values for rollover_acct_status

Values Description
0 INACTIVE
1 ACTIVE
2 CANCELLATION PENDING
3 TERMINATION PENDING
10 ACTIVE DUNNING PENDING
11 ACTIVE DUNNING 1
12 ACTIVE DUNNING 1
13 ACTIVE DUNNING 3
14 ACTIVE DUNNING 4
15 ACTIVE DUNNING 5
16 ACTIVE DUNNING 6
17 ACTIVE DUNNING 7
18 ACTIVE DUNNING 8
21 REINSTATED FORWARD BILL
22 REINSTATED BACK BILL
31 INSTALLATION PENDING
32 REGISTERED PENDING ACTIVATION
41 ACTIVE TRIAL
51 TEMPORARY SERVICE BAN
61 ACTIVE NON-BILLABLE
99 PERMANENT
-1 SUSPENDED
-2 CANCELLED
-3 TERMINATED
-4 CONTRACT EXPIRED
-11 SUSPENDED DUNNING 1
-12 SUSPENDED DUNNING 2
-13 SUSPENDED DUNNING 3
-14 SUSPENDED DUNNING 4
-15 SUSPENDED DUNNING 5
-99 ARCHIVED
brd_arrow.gif rollover_acct_status_days long Number of days in which an account will change from the initial status code to the pre-defined rollover status code.
brd_arrow.gif init_free_months long Initial free months.
brd_arrow.gif plan_2_assign_on_susp long Plan to assign when an account on this plan is suspended.
brd_arrow.gif default_notify_method long Default notification method given to an account that is assigned to this plan. 

Allowable values for default_notify_method

Values Description
0 None
1 HTML Email
2 Text Email
3 Text Email w/link to HTML
4 Data export
5 Printable (no Email) w/Surcharge
6 Printable & Text Email
7 Printable & HTML Email w/Surcharge
8 Printable (no Email)
9 PDF (Printing required, no Email)
10 PDF (delivered by Email)
11 PDF (Printing req & Email)w/surcharge
12 PDF (Printing req, no Email)w/surcharge
13 XML Master File
14 PDF Master File
brd_arrow.gif prepaid_ind long Indicates whether or not this plan is prepaid 

Allowable values for prepaid_ind

Values Description
0 0
1 1
brd_arrow.gif currency_cd string The 3-character ISO-compliant currency code in lowercase for monetary values used in the context of this API method.
brd_arrow.gif client_plan_id string Client assigned unique plan identifier
brd_arrow.gif client_rollover_plan_id string Pre-defined client rollover plan ID to which the account will change based on the defined rollover_months value; the rollover record is created when an account is placed on a plan with a defined client rollover plan ID.
brd_arrow.gif proration_invoice_timing_cd string Indicates whether to defer the pro-rated charges to the next anniversary date or to create a seperate invoice immediately. 

Allowable values for proration_invoice_timing_cd

Values Description
I Indicates to generate the invoice immediately for the pro-rated charges.
A Indicates to generate the invoice to the next anniversary date for the pro-rated charges.
brd_arrow.gif plan_services hash A multidimensional array of Services for this plan
brd_arrow.gif service_no long A multidimensional array of Services for this plan
brd_arrow.gif service_desc string Description of this service
brd_arrow.gif is_recurring_ind long Indicates whether or not this service is a recurring service 

Allowable values for is_recurring_ind

Values Description
0 0
1 1
brd_arrow.gif is_usage_based_ind long Indicates whether or not this service is a usage based service 

Allowable values for is_usage_based_ind

Values Description
0 0
1 1
brd_arrow.gif usage_type long The usage type supported by this usage based service
brd_arrow.gif taxable_ind long Indicates whether or not this service is taxable 

Allowable values for taxable_ind

Values Description
0 0
1 1
brd_arrow.gif is_tax_ind long Indicates whether or not this service is a tax based service 

Allowable values for is_tax_ind

Values Description
0 0
1 1
brd_arrow.gif is_arrears_ind long Indicates whether or not this service is an arrears based service 

Allowable values for is_arrears_ind

Values Description
0 0
1 1
brd_arrow.gif is_setup_ind long Indicates whether or not this service is a setup bases service 

Allowable values for is_setup_ind

Values Description
0 0
1 1
brd_arrow.gif is_misc_ind long Indicates whether or not this service is a miscellaneous service 

Allowable values for is_misc_ind

Values Description
0 0
1 1
brd_arrow.gif is_donation_ind long Indicates whether or not this service is a donation based service 

Allowable values for is_donation_ind

Values Description
0 0
1 1
brd_arrow.gif is_order_based_ind long Indicates whether or not this service is an order based service 

Allowable values for is_order_based_ind

Values Description
0 0
1 1
brd_arrow.gif is_cancellation_ind long Indicates whether or not this service is a cancellation based service 

Allowable values for is_cancellation_ind

Values Description
0 0
1 1
brd_arrow.gif coa_id string Chart of accounts ID
brd_arrow.gif ledger_code string This field is deprecated in favor of coa_id
brd_arrow.gif client_coa_code string The client-defined override for coa_id
brd_arrow.gif display_ind long Indicates if this service is displayable or not 

Allowable values for display_ind

Values Description
0 0
1 1
brd_arrow.gif tiered_pricing_rule long The Tiered Pricing Rule 

Allowable values for tiered_pricing_rule

Values Description
1 Standard
2 Volume Discount
3 Flat Rate Per Tier
brd_arrow.gif is_min_fee_ind long Indicates whether or not this service is a minimum fee. 

Allowable values for is_min_fee_ind

Values Description
0 0
1 1
brd_arrow.gif client_service_id string A multidimensional array of client-defined Service ID for this plan.
brd_arrow.gif usage_type_cd string An array containing usage_type_cd(s) to denote which usage type(s) to record.
brd_arrow.gif all_service_supp_fields hash  
brd_arrow.gif field_name string The machine-readable name of this field
brd_arrow.gif field_desc string The human-readable name of this field
brd_arrow.gif field_order_no long The sort order of this field
brd_arrow.gif field_value string The value stored in this field
brd_arrow.gif fulfillment_based_ind long Indicates if the service is Fulfillment Based or not.
brd_arrow.gif plan_service_rates hash Represents the rates for the default rate schedule for the default currency for the plan
brd_arrow.gif rate_seq_no long Sequential number in the rate schedule for dertermining tiers
brd_arrow.gif from_unit double Tiered Units (from) This value represents the start of a tiered range of values.
brd_arrow.gif to_unit double Tiered Units (to) This value represents the end of the range for a single tier of values.
brd_arrow.gif rate_per_unit double The cost per unit of this service over the time period the plan is billed for
brd_arrow.gif future_rate_per_unit double The future cost per unit of this service over the time period the plan is billed for
brd_arrow.gif monthly_fee double If the plan interval is more than one month, this field will rate per unit per month
brd_arrow.gif client_rate_schedule_id string Client assigned unique rate schedule number
brd_arrow.gif rate_tier_description string Rate Tier Description
brd_arrow.gif all_plan_service_rates hash All rates for all rate schedules and currencies for this plan
brd_arrow.gif schedule_no long Rate schedule number
brd_arrow.gif client_rate_schedule_id string Client assigned unique rate schedule number
brd_arrow.gif future_rate long Indicates whether future rates are captured or not. 

Allowable values for future_rate

Values Description
0 false, i.e., no future rate.
1 True, i.e., future rates are captured.
  null, i.e., no future rate.
brd_arrow.gif future_change_date string Future Change Date of the rates.
brd_arrow.gif followup_rs_no long Aria internal id of follow-up default rate schedule
brd_arrow.gif client_followup_rs_id string Client defined id of followup rate schedule
brd_arrow.gif plan_service_rates hash Represents the rates for the default rate schedule for the default currency for the plan
brd_arrow.gif rate_seq_no long Sequential number in the rate schedule for dertermining tiers
brd_arrow.gif from_unit double Tiered Units (from) This value represents the start of a tiered range of values.
brd_arrow.gif to_unit double Tiered Units (to) This value represents the end of the range for a single tier of values.
brd_arrow.gif rate_per_unit double The cost per unit of this service over the time period the plan is billed for
brd_arrow.gif future_rate_per_unit double The future cost per unit of this service over the time period the plan is billed for
brd_arrow.gif monthly_fee double If the plan interval is more than one month, this field will rate per unit per month
brd_arrow.gif client_rate_schedule_id string Client assigned unique rate schedule number
brd_arrow.gif rate_tier_description string Rate Tier Description
brd_arrow.gif usage_type_name string The human-readable name of this usage type
brd_arrow.gif usage_type_desc string The long description of this usage type
brd_arrow.gif usage_type_code string Client-assigned identifier for the type of usage being recorded.
brd_arrow.gif usage_unit_label string The display-level description of the units this usage represents.
brd_arrow.gif apply_usage_rates_daily long Indicates whether or not this usage-based service is rated on a daily basis. 

Allowable values for apply_usage_rates_daily

Values Description
0 usage shall be rated based on the entire billing period
1 usage shall be rated based on one day periods individually.
brd_arrow.gif plan_rate_schedules hash All the rate schedules associated with this plan
brd_arrow.gif schedule_no long The ID of this rate schedule
brd_arrow.gif schedule_name string The name of this rate schedule
brd_arrow.gif schedule_currency string The currency this rate schedule is linked to
brd_arrow.gif schedule_default_ind long If true, this is the default rate schedule for the default currency 

Allowable values for schedule_default_ind

Values Description
0 0
1 1
brd_arrow.gif schedule_default_ind_curr long If true, this is the default rate schedule for the specified currency
brd_arrow.gif schedule_display_ind long Determines whether the rate schedule is displayable 

Allowable values for schedule_display_ind

Values Description
0 0
1 1
brd_arrow.gif client_rate_schedule_id string Client assigned unique rate schedule number
brd_arrow.gif available_from_date string Start date of rate schedule
brd_arrow.gif available_to_date string End date of rate schedule
brd_arrow.gif future_rate long Indicates whether future rates are captured or not 

Allowable values for future_rate

Values Description
0 false, i.e., no future rate.
1 True, i.e., future rates are captured.
  false, i.e., no future rate.
brd_arrow.gif future_change_date string Future Change Date of the rates.
brd_arrow.gif followup_rs_no long Aria internal id of follow-up default rate schedule
brd_arrow.gif client_followup_rs_id string Client defined id of followup rate schedule
brd_arrow.gif plan_groups hash A grouping of plans which can be used for plan assignment
brd_arrow.gif plan_group_no long The ID of this plan group
brd_arrow.gif plan_group_name string The name of this plan group
brd_arrow.gif plan_group_desc string The long description of this plan group
brd_arrow.gif plan_group_usage string Determines where the plan groups are made available 

Allowable values for plan_group_usage

Values Description
C By CSRs only within AdminTools
U Within your User Self Service applications only
B For both CSR and USS
brd_arrow.gif selectable_ind long Whether or not this plan group is selectable 

Allowable values for selectable_ind

Values Description
0 0
1 1
brd_arrow.gif client_plan_group_id string Client-defined ID for this plan group
brd_arrow.gif promotional_plan_sets hash A grouping of plans based on promo code
brd_arrow.gif promo_set_no long The ID of this promotional plan set
brd_arrow.gif promo_set_name string The name of this promotional plan set
brd_arrow.gif promo_set_desc string The long description of this promotional plan set
brd_arrow.gif promotions_for_set hash The promo codes associated with this group of plans
brd_arrow.gif promo_code string The promo code itself
brd_arrow.gif promo_code_desc string A long description of this promo code
brd_arrow.gif client_promo_set_id string Client-defined ID of this promotional plan set
brd_arrow.gif parent_plans hash The plans which are mapped as parents of this plan
brd_arrow.gif parent_plan_no long ID of the parent plan
brd_arrow.gif parent_plan_name string Name of the parent plan
brd_arrow.gif client_parent_plan_id string Client-defined unique parent Plan ID
brd_arrow.gif plan_supp_fields hash Supplemental object fields associated with this plan
brd_arrow.gif plan_supp_field_no long Supplemental object field ID
brd_arrow.gif plan_supp_field_name string Name of the supplemental object field
brd_arrow.gif plan_supp_field_desc string Description of the supplemental object field
brd_arrow.gif plan_supp_field_value string The value in this supplemental field on the plan
brd_arrow.gif first_retrieval_level_ind string If true, this plan met the initial filtering criteria used to retrieve this list of plans. If false, this plan is a child plan (or other decendant) of a plan which met the initial criteria 

Allowable values for first_retrieval_level_ind

Values Description
true true
false false
brd_arrow.gif child_plan_no hash The plans which are mapped as children of this plan
brd_arrow.gif plan_no long Aria-assigned plan identifier. This value is unique across all Aria-managed accounts.
brd_arrow.gif client_plan_id string Client-defined Plan ID for which to query available child plans
 
 
 
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.