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
client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
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
supp_field_names string array 300 An array of client-specified supplemental field names
supp_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
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

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.
plan_no long Aria-assigned unique plan identifier
plan_name string Plan Name
plan_desc string Text description of this plan
supp_plan_ind long Indicates whether or not this plan is a supplemental plan.  Allowable Values
billing_interval long Number of months between billing cycles
billing_ind long Indicates whether or not this plan is billable  Allowable Values
display_ind long Indicates whether or not the plan is marked as "displayable". 0 means not displayable. 1 means displayable.  Allowable Values
rollover_months long Number of months in which the account will change from the current plan to the pre-defined rollover plan.
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.
early_cancel_fee double Fee charged for early cancellations.
early_cancel_min_months long Number of months during which early cancellation fees would apply on plan cancellation.
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.
new_acct_status long The status code to assert for the new account.  Allowable Values
rollover_acct_status long Default status for new accounts created on this plan.  Allowable Values
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.
init_free_months long Initial free months.
plan_2_assign_on_susp long Plan to assign when an account on this plan is suspended.
default_notify_method long Default notification method given to an account that is assigned to this plan.  Allowable Values
prepaid_ind long Indicates whether or not this plan is prepaid  Allowable Values
currency_cd string The 3-character ISO-compliant currency code in lowercase for monetary values used in the context of this API method.
client_plan_id string Client assigned unique plan identifier
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.
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
plan_services hash A multidimensional array of Services for this plan
service_no long A multidimensional array of Services for this plan
service_desc string Description of this service
is_recurring_ind long Indicates whether or not this service is a recurring service  Allowable Values
is_usage_based_ind long Indicates whether or not this service is a usage based service  Allowable Values
usage_type long The usage type supported by this usage based service
taxable_ind long Indicates whether or not this service is taxable  Allowable Values
is_tax_ind long Indicates whether or not this service is a tax based service  Allowable Values
is_arrears_ind long Indicates whether or not this service is an arrears based service  Allowable Values
is_setup_ind long Indicates whether or not this service is a setup bases service  Allowable Values
is_misc_ind long Indicates whether or not this service is a miscellaneous service  Allowable Values
is_donation_ind long Indicates whether or not this service is a donation based service  Allowable Values
is_order_based_ind long Indicates whether or not this service is an order based service  Allowable Values
is_cancellation_ind long Indicates whether or not this service is a cancellation based service  Allowable Values
coa_id string Chart of accounts ID
ledger_code string This field is deprecated in favor of coa_id
client_coa_code string The client-defined override for coa_id
display_ind long Indicates if this service is displayable or not  Allowable Values
tiered_pricing_rule long The Tiered Pricing Rule  Allowable Values
is_min_fee_ind long Indicates whether or not this service is a minimum fee.  Allowable Values
client_service_id string A multidimensional array of client-defined Service ID for this plan.
usage_type_cd string An array containing usage_type_cd(s) to denote which usage type(s) to record.
all_service_supp_fields hash
field_name string The machine-readable name of this field
field_desc string The human-readable name of this field
field_order_no long The sort order of this field
field_value string The value stored in this field
fulfillment_based_ind long Indicates if the service is Fulfillment Based or not.
plan_service_rates hash Represents the rates for the default rate schedule for the default currency for the plan
rate_seq_no long Sequential number in the rate schedule for dertermining tiers
from_unit double Tiered Units (from) This value represents the start of a tiered range of values.
to_unit double Tiered Units (to) This value represents the end of the range for a single tier of values.
rate_per_unit double The cost per unit of this service over the time period the plan is billed for
future_rate_per_unit double The future cost per unit of this service over the time period the plan is billed for
monthly_fee double If the plan interval is more than one month, this field will rate per unit per month
client_rate_schedule_id string Client assigned unique rate schedule number
rate_tier_description string Rate Tier Description
all_plan_service_rates hash All rates for all rate schedules and currencies for this plan
schedule_no long Rate schedule number
client_rate_schedule_id string Client assigned unique rate schedule number
future_rate long Indicates whether future rates are captured or not.  Allowable Values
future_change_date string Future Change Date of the rates.
followup_rs_no long Aria internal id of follow-up default rate schedule
client_followup_rs_id string Client defined id of followup rate schedule
plan_service_rates hash Represents the rates for the default rate schedule for the default currency for the plan
rate_seq_no long Sequential number in the rate schedule for dertermining tiers
from_unit double Tiered Units (from) This value represents the start of a tiered range of values.
to_unit double Tiered Units (to) This value represents the end of the range for a single tier of values.
rate_per_unit double The cost per unit of this service over the time period the plan is billed for
future_rate_per_unit double The future cost per unit of this service over the time period the plan is billed for
monthly_fee double If the plan interval is more than one month, this field will rate per unit per month
client_rate_schedule_id string Client assigned unique rate schedule number
rate_tier_description string Rate Tier Description
usage_type_name string The human-readable name of this usage type
usage_type_desc string The long description of this usage type
usage_type_code string Client-assigned identifier for the type of usage being recorded.
usage_unit_label string The display-level description of the units this usage represents.
apply_usage_rates_daily long Indicates whether or not this usage-based service is rated on a daily basis.  Allowable Values
plan_rate_schedules hash All the rate schedules associated with this plan
schedule_no long The ID of this rate schedule
schedule_name string The name of this rate schedule
schedule_currency string The currency this rate schedule is linked to
schedule_default_ind long If true, this is the default rate schedule for the default currency  Allowable Values
schedule_default_ind_curr long If true, this is the default rate schedule for the specified currency
schedule_display_ind long Determines whether the rate schedule is displayable  Allowable Values
client_rate_schedule_id string Client assigned unique rate schedule number
available_from_date string Start date of rate schedule
available_to_date string End date of rate schedule
future_rate long Indicates whether future rates are captured or not  Allowable Values
future_change_date string Future Change Date of the rates.
followup_rs_no long Aria internal id of follow-up default rate schedule
client_followup_rs_id string Client defined id of followup rate schedule
plan_groups hash A grouping of plans which can be used for plan assignment
plan_group_no long The ID of this plan group
plan_group_name string The name of this plan group
plan_group_desc string The long description of this plan group
plan_group_usage string Determines where the plan groups are made available  Allowable Values
selectable_ind long Whether or not this plan group is selectable  Allowable Values
client_plan_group_id string Client-defined ID for this plan group
promotional_plan_sets hash A grouping of plans based on promo code
promo_set_no long The ID of this promotional plan set
promo_set_name string The name of this promotional plan set
promo_set_desc string The long description of this promotional plan set
promotions_for_set hash The promo codes associated with this group of plans
promo_code string The promo code itself
promo_code_desc string A long description of this promo code
client_promo_set_id string Client-defined ID of this promotional plan set
parent_plans hash The plans which are mapped as parents of this plan
parent_plan_no long ID of the parent plan
parent_plan_name string Name of the parent plan
client_parent_plan_id string Client-defined unique parent Plan ID
plan_supp_fields hash Supplemental object fields associated with this plan
plan_supp_field_no long Supplemental object field ID
plan_supp_field_name string Name of the supplemental object field
plan_supp_field_desc string Description of the supplemental object field
plan_supp_field_value string The value in this supplemental field on the plan
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
child_plan_no hash The plans which are mapped as children of this plan
plan_no long Aria-assigned plan identifier. This value is unique across all Aria-managed accounts.
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.
Powered by CXone Expert ®