Skip to main content
Aria Knowledge Central

get_plan_details_m

  1. Last updated
  2. Save as PDF

Summary

API Name get_plan_details_m
Class administration_services_m
Update Version 5.6

Description

Returns details for specified service plan

Inputs

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.
plan_no long 100 Yes

Plan Number

Alternative required field: client_plan_id
client_plan_id string 100 Yes

Client defined unique identifier

Alternative required field: plan_no
include_rs_summary string 10 No

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 No

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 No

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 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.

Outputs

Name Type Length 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.
plan_no long 100 No

Plan Number
client_plan_id string 100 No

Client defined unique identifier
plan_level int 1 No

Plan Level. [can be 0 or 1]; 0 - Master plan 1 - indicates Supplemental Plan
plan_type string 20 No

Specifies Plan Type. Valid values are [ Recurring, Free, Pre-paid, Unknown ]
plan_name string 100 No

Plan Name
plan_desc string   No

Specifies plan description
Start of plan_groups object
plan_groups object   No

The plan_groups associated with this method.
Name Type Length Required Description
▶plan_group int 3 Yes

Plan Group Number
End of plan_groups object
Start of plan_group_ids object
plan_group_ids object   No

The plan_group_ids associated with this method.
Name Type Length Required Description
▶plan_group_id string 100 Yes

Client defined unique identifier
End of plan_group_ids object
currency_cd string 3 No

Specifies the currency code of plan
active_ind int 1 No

Specifies if inventory item is active or inactive. Valid values are: 0 - Inactive and 1 - Active
rollover_plan_duration int   No

Duration of the plan rollover period (used in conjunction with rollover_plan_uom_cd).
rollover_plan_uom_cd int   No

Units associated with the duration of the plan rollover period (used in conjunction with rollover_plan_duration).

Allowed values:

Value Description
1 Day
2 Week
3 Month
4 Quarter
5 Year
rollover_plan_no long 100 No

Plan number
rollover_client_plan_id string 100 No

Client defined identifier for rollover plan number
init_free_period_duration int   No

Duration of the initial free period (used in conjunction with init_free_period_uom_cd).
init_free_period_uom_cd int   No

Units associated with the duration of the initial free period (used in conjunction with init_free_period_duration).

Allowed values:

Value Description
1 Day
2 Week
3 Month
4 Quarter
5 Year
initial_plan_status_cd int   No

Default status used when master plan is initially assigned on an account.

Allowed values:

Value Description
1 Active
31 Pending Installation
32 Pending Activation
41 Trial
61 Active Non-Billable
rollover_plan_status_duration int   No

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   No

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).

Allowed values:

Value Description
1 Day
2 Week
3 Month
4 Quarter
5 Year
rollover_plan_status_cd int   No

Status used for the master plan instance at the completion of the plan status rollover period.
allow_child_accounts string   No  
dunning_plan_no long 100 No

Specifies dunning plan associated with this plan
dunning_client_plan_id string 100 No

Specifies client defined identifier of the dunning plan associated with this plan
acct_status_cd string   No  
rollover_acct_status_days int   No  
rollover_acct_status_cd string   No  
template_no long 8 No

Specifies invoice template class associated with master plan
template_id string 100 No

Specifies client defined identifier for the invoice template class associated with master plan
plan_cancel_min_months int 5 No

Specifies the minimum term months for cancellation service
how_to_apply_min_fee string   No  
is_deletable string   No  
Start of services object
services object   No

The services associated with this method.
Name Type Length Required Description
▶service_no long 8 Yes

Service number
▶client_service_id string 100 No

Client defined identifier for service
End of services object
Start of parent_plans object
parent_plans object   No

The parent_plans associated with this method.
Name Type Length Required Description
▶parent_plan int 3 No

Plan Number of parent plan
End of parent_plans object
Start of parent_plan_ids object
parent_plan_ids object   No

The parent_plan_ids associated with this method.
Name Type Length Required Description
▶parent_plan_id string 100 Yes

Client defined identifier for parent plan
End of parent_plan_ids object
Start of exclusion_plans object
exclusion_plans object   No

The exclusion_plans associated with this method.
Name Type Length Required Description
▶exclusion_plan int 3 No

Exclusion Plan Number
End of exclusion_plans object
Start of resources object
resources object   No

The resources associated with this method.
Name Type Length Required Description
▶resources int   Yes  
▶resource_type_no long   Yes

Resource Type number
▶resource_units int   Yes

No. of units
▶expire_on_paid_through int   Yes

Expires on paid through data
▶reset_on_update int   Yes  
▶add_days_to_expiry int   Yes  
End of resources object
Start of supplemental_obj_fields object
supplemental_obj_fields object   No

The supplemental_obj_fields associated with this method.
Name Type Length Required Description
▶field_no long 100 No

the field no
▶field_value string   No

the field value
▶field_name string 100 No

the field name
End of supplemental_obj_fields object
Start of surcharges object
surcharges object   No

The surcharges associated with this method.
Name Type Length Required Description
▶surcharge_no long 12 No

Specifies the surcharge_no associated with this plan.
▶client_surcharge_id string 100 No

Specifies the client defined id for the surcharges associated with this plan.
End of surcharges object
is_advanced_usage_pricing int 1 No

Indicates if the plan is configured for Advanced Usage Pricing
proration_invoice_timing_cd string 1 No

Specifies whether to create a separate invoice for prorated charges immediately, or defer to the next anniversary date.
Start of rate_sched object
rate_sched object   No

The rate_sched associated with this method.
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   No

Recurring Billing Period Type can be either of 1, 2, 3
▶usage_billing_interval int   No

Usage billing interval
▶usage_billing_period_type int   No

Usage Billing Period Type can be either of 1, 2, 3
▶default_ind int   No

Plan default indicator
▶default_ind_curr int   No

Currency default indicator
▶available_from_dt string   No

Available Start Date
▶available_to_dt string   No

Available End Date
▶future_rate boolean 1 No

Schedule Future Rate Change indicator
▶future_change_dt string   No

Future Rate Change Start Date
▶followup_rs_no long   No

Follow-up Rate Schedule No
Start of service_rates object
▶service_rates object   No

The service_rates associated with this method.
Name Type Length Required Description
▶▶service_no long 10 No

Service Number
Start of rate_tiers object
▶▶rate_tiers object   No

The rate_tiers associated with this method.
Name Type Length Required Description
▶▶▶from_units long 10 No

Tier From start range
▶▶▶to_units long 10 No

Tier To end range
▶▶▶description string   No

Tier description
▶▶▶rate_per_unit float   No

Tier current rate
▶▶▶future_rate_per_unit float   No

Tier schedule future rate
End of rate_tiers object
End of service_rates object
End of rate_sched object
contract_rollover_plan_no long 100 No

Pre-defined plan to be used as the rollover plan at the completion of the contract
contract_rollover_client_plan_id string 100 No

Client-defined id of the pre-defined plan to be used as the rollover plan at the completion of a contract
Start of contract_rollover_rate_sched object
contract_rollover_rate_sched object   No

The contract_rollover_rate_sched associated with this method.
Name Type Length Required Description
▶current_rate_sched_no long 100 No

Current rate schedule for which the rollover rate schedule is being defined
▶current_client_rate_sched_id string 100 No

Client-defined id of the current rate schedule for which the rollover rate schedule is being defined
▶rollover_rate_sched_no long 100 No

Pre-defined rate schedule to be used as the rollover rate schedule at the completion of the contract
▶rollover_client_rate_sched_id string 100 No

Client-defined id of the pre-defined rate schedule to be used as the rollover rate schedule at the completion of the contract
End of contract_rollover_rate_sched object
Start of plan_nso_items object
plan_nso_items object   No

Non-Subscription Offerings that are bundled with the plan.
Name Type Length Required Description
▶item_no long 100 No

Inventory item number that is bundled with the plan.
▶active_ind int 1 No

Inventory item status.

Allowed values:

Value Description
0 Inactive
10 Active
▶min_qty string 100 No

Minimum NSO quantity needed during plan purchase.
▶max_qty string 100 No

Maximum NSO quantity needed during plan purchase.
▶item_scope string 1 No

Scope of bundled NSO during plan purchase.

Allowed values:

Value Description
U Up to Plan Units.
M Match Plan Units.
A Any Units.
Start of plan_nso_price_override object
▶plan_nso_price_override object   No

Overridden prices for NSO items.
Name Type Length Required Description
▶▶rate_schedule_no long 100 No

The internal Id of the rate schedule.
▶▶client_rate_schedule_id string 100 No

Client assigned unique rate schedule number.
▶▶currency_cd string 3 No

Currency code for Inventory item.
▶▶override_price string 100 No

Overridden price for Inventory item for currencies.

Note: This field was deprecated in version 28.
▶▶bundle_nso_rate_schedule_no long 100 No

Aria-assigned unique identifier for the rate schedule to be used as the bundle price for the NSO when purchased with this plan.
▶▶bundle_client_nso_rate_schedule_id string 100 No

Client-defined unique identifier for the rate schedule to be used as the bundle price for the NSO when purchased with this plan.
End of plan_nso_price_override object
Start of installment_terms object
▶installment_terms object   No

The installment_terms associated with this method.
Name Type Length Required Description
▶▶installment_term_no long   No

Aria-assigned unique identifier for client installment term.
▶▶client_installment_term_id string   No

Specifies client installment term id
▶▶installment_term_name string 100 No

Specifies installment term name
▶▶is_default int 1 No

The value of 1 is defaulted for the first installment term denoting it is the default. For subsequent installment terms, the default is set to 0. Alternate boolean values are accepted.
End of installment_terms object
End of plan_nso_items object
Start of plan_nso_group object
plan_nso_group object   No

Non-Subscription Offerings that are bundled with the plan as part of NSO group.
Name Type Length Required Description
▶item_no long 100 No

Inventory item number that is bundled with the plan as part of NSO group.
▶active_ind int 1 No

Inventory item status.

Allowed values:

Value Description
0 Inactive
10 Active
Start of plan_nso_group_price_override object
▶plan_nso_group_price_override object   No

Overridden prices for NSO items.
Name Type Length Required Description
▶▶rate_schedule_no long 100 No

The internal Id of the rate schedule.
▶▶client_rate_schedule_id string 100 No

Client assigned unique rate schedule number.
▶▶currency_cd string 3 No

Currency code for Inventory item.
▶▶override_price string 100 No

Overridden price for Inventory item for currencies.

Note: This field was deprecated in version 28.
▶▶bundle_nso_rate_schedule_no long 100 No

Aria-assigned unique identifier for the rate schedule to be used as the bundle price for the NSO when purchased with this plan.
▶▶bundle_client_nso_rate_schedule_id string 100 No

Client-defined unique identifier for the rate schedule to be used as the bundle price for the NSO when purchased with this plan.
End of plan_nso_group_price_override object
End of plan_nso_group object
nso_group_min_qty string 100 No

Minimum NSO quantity needed during plan purchase for the NSO group.
nso_group_max_qty string 100 No

Maximum NSO quantity needed during plan purchase for the NSO group.
nso_group_item_scope string 1 No

Scope of bundled NSO group during plan purchase.

Allowed values:

Value Description
U Up to Plan Units.
M Match Plan Units.
A Any Units.
nso_incl_list_scope int 1 No

Scope of additional NSO as part of inclusion list

Allowed values:

Value Description
0 All non-restricted inventory items (default)
1 Existing bundled and non-restricted inventory items
2 Existing bundled inventory items only
3 Selected and non-restricted inventory items
4 Selected specific inventory items
Start of plan_nso_incl_list object
plan_nso_incl_list object   No

The plan_nso_incl_list associated with this method.
Name Type Length Required Description
▶item_no long 37 No

Specifies the Inventory item number. Mandatory inside array for nso_incl_list_scope is 3 or 4.
▶active_ind int 1 No

Inventory item status.

Allowed values:

Value Description
0 Inactive.
1 Active.
End of plan_nso_incl_list object
Start of plan_translation_info object
plan_translation_info object   No

Array that contains all the translated values for a given locale.
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
Start of rate_sched_t object
▶rate_sched_t object   No

The rate_sched_t associated with this method.
Name Type Length Required Description
▶▶schedule_no long 10 No

Schedule Number
▶▶schedule_name string   No

Schedule Name
End of rate_sched_t object
End of plan_translation_info object
Start of plan_field_categories object
plan_field_categories object   No

The plan_field_categories associated with this method.
Name Type Length Required Description
▶field_category_no long 100 Yes

Field Category number
▶field_category_name string 100 No

Field Category name
End of plan_field_categories object
TOP
  1. Back to top
  • Was this article helpful?

Recommended articles

  1. Page type
    Topic
  2. Tags
    This page has no tags.