Search the Aria Knowledgebase for
User Documentation, APIs, SDKs, and more!

 

Home > Aria Crescendo admintools api > get_plan_details_m

get_plan_details_m

Returns details for specified service plan

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 int 100 Plan Number
OR
client_plan_id string 100 Client defined unique identifier
include_rs_summary string 10 Boolean - true/false. Summary level rate schedule information for all the rate schedules that are associated with a particular plan.
retrieve_bundled_nso string 10 Boolean - true/false. If set to "true", will retrieve all the bundled NSOs of type inventory item with a particular plan. If left blank, will default to "false".
retrieve_included_nso string 10 Boolean - true/false. If set to "true", will retrieve all the included NSOs of type inventory item with a particular plan. If left blank, will default to "false".
locale_no int 38 Aria-assigned unique identifier of the locale used for translations.
OR
locale_name string 32 Name of the locale to which the translations belong.
include_translations string 1 Setting this flag as True will fetch the translated fields in all the locales defined. If not passed it defaults to False.   Allowable Values

Output Arguments

Field Name Field Type Description
error_code long Aria-assigned error identifier. 0 indicates no error
error_msg string Textual description of any error that occurred. "OK" if there was no error.
plan_no int Plan Number
client_plan_id string Client defined unique identifier
plan_level int Plan Level. [can be 0 or 1]; 0 - Master plan 1 - indicates Supplemental Plan
plan_type string Specifies Plan Type. Valid values are [ Recurring, Free, Pre-paid, Unknown ]
plan_name string Plan Name
plan_desc string Specifies plan description
plan_groups hash
plan_group int Plan Group Number
plan_group_ids hash
plan_group_id string Client defined unique identifier
currency_cd string Specifies the currency code of plan
active_ind int Specifies if inventory item is active or inactive. Valid values are: 0 - Inactive and 1 - Active
rollover_plan_duration int Duration of the plan rollover period (used in conjunction with rollover_plan_uom_cd).
rollover_plan_uom_cd int Units associated with the duration of the plan rollover period (used in conjunction with rollover_plan_duration).   Allowable Values
rollover_plan_no int Plan number
rollover_client_plan_id string Client defined identifier for rollover plan number
init_free_period_duration int Duration of the initial free period (used in conjunction with init_free_period_uom_cd).
init_free_period_uom_cd int Units associated with the duration of the initial free period (used in conjunction with init_free_period_duration).   Allowable Values
initial_plan_status_cd int Default status used when master plan is initially assigned on an account.
rollover_plan_status_duration int Duration of the plan status rollover period, after which the initial plan status on the master plan instance will change to the pre-defined rollover plan status (used in conjuction with rollover_plan_status_uom_cd).
rollover_plan_status_uom_cd int Units associated with the duration of the plan status rollover period after which the initial plan status on the master plan instance will change to the pre-defined rollover plan status (used in conjunction with rollover_plan_status_duration).   Allowable Values
rollover_plan_status_cd int Status used for the master plan instance at the completion of the plan status rollover period.
allow_child_accounts string
dunning_plan_no int Specifies dunning plan associated with this plan
dunning_client_plan_id string Specifies client defined identifier of the dunning plan associated with this plan
acct_status_cd string
rollover_acct_status_days int
rollover_acct_status_cd string
template_no int Specifies invoice template class associated with master plan
template_id string Specifies client defined identifier for the invoice template class associated with master plan
plan_cancel_min_months int Specifies the minimum term months for cancellation service
how_to_apply_min_fee string
is_deletable string
services hash
service_no int Service number
client_service_id string Client defined identifier for service
parent_plans hash
parent_plan int Plan Number of parent plan
parent_plan_ids hash
parent_plan_id string Client defined identifier for parent plan
exclusion_plans hash
exclusion_plan int Exclusion Plan Number
resources hash
resources int
resource_type_no int Resource Type number
resource_units int No. of units
expire_on_paid_through int Expires on paid through data
reset_on_update int
add_days_to_expiry int
supplemental_obj_fields hash
field_no int the field no
field_value string the field value
field_name string the field name
surcharges hash
surcharge_no hash
surcharge_nos int Specifies the surcharge_no associated with this plan.
client_surcharge_id hash
client_surcharge_ids string Specifies the client defined id for the surcharges associated with this plan.
proration_invoice_timing_cd string Specifies whether to create a separate invoice for prorated charges immediately, or defer to the next anniversary date.
rate_sched hash
schedule_no int Schedule Number
client_rate_schedule_id string Client defined unique id for the schedule
schedule_name string Schedule Name
schedule_currency string Schedule currency
recurring_billing_interval int Recurring billing interval
usage_billing_interval int Usage billing interval
default_ind int Plan default indicator
default_ind_curr int Currency default indicator
contract_rollover_plan_no int Pre-defined plan to be used as the rollover plan at the completion of the contract
contract_rollover_client_plan_id string Client-defined id of the pre-defined plan to be used as the rollover plan at the completion of a contract
contract_rollover_rate_sched hash
current_rate_sched_no int Current rate schedule for which the rollover rate schedule is being defined
current_client_rate_sched_id string Client-defined id of the current rate schedule for which the rollover rate schedule is being defined
rollover_rate_sched_no int Pre-defined rate schedule to be used as the rollover rate schedule at the completion of the contract
rollover_client_rate_sched_id string Client-defined id of the pre-defined rate schedule to be used as the rollover rate schedule at the completion of the contract
plan_nso_items hash Non-Subscription Offerings that are bundled with the plan.
item_no int Inventory item number that is bundled with the plan.
active_ind int Inventory item status.   Allowable Values
min_qty string Minimum NSO quantity needed during plan purchase.
max_qty string Maximum NSO quantity needed during plan purchase.
item_scope string Scope of bundled NSO during plan purchase.   Allowable Values
plan_nso_price_override hash Overridden prices for NSO items.
rate_schedule_no int The internal Id of the rate schedule.
client_rate_schedule_id string Client assigned unique rate schedule number.
currency_cd string Currency code for Inventory item.
override_price string Overridden price for Inventory item for currencies.
plan_nso_group hash Non-Subscription Offerings that are bundled with the plan as part of NSO group.
item_no int Inventory item number that is bundled with the plan as part of NSO group.
active_ind int Inventory item status.   Allowable Values
plan_nso_group_price_override hash Overridden prices for NSO items.
rate_schedule_no int The internal Id of the rate schedule.
client_rate_schedule_id string Client assigned unique rate schedule number.
currency_cd string Currency code for Inventory item.
override_price string Overridden price for Inventory item for currencies.
nso_group_min_qty string Minimum NSO quantity needed during plan purchase for the NSO group.
nso_group_max_qty string Maximum NSO quantity needed during plan purchase for the NSO group.
nso_group_item_scope string Scope of bundled NSO group during plan purchase.   Allowable Values
nso_incl_list_scope int Scope of additional NSO as part of inclusion list   Allowable Values
plan_nso_incl_list hash
item_no int Specifies the Inventory item number. Mandatory inside array for nso_incl_list_scope is 3 or 4.
active_ind int Inventory item status.   Allowable Values
plan_translation_info hash Array that contains all the translated values for a given locale.
locale_name string Name of the locale
locale_no int Aria-assigned unique identifier of the locale used for translations.
plan_no string Plan Number
plan_name string Plan Name
description string Specifies plan description
rate_sched_t hash
schedule_no int Schedule Number
schedule_name string Schedule Name

You must to post a comment.
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.