get_plan_details_m

Last updated
Save as PDF

Returns details for specified service plan

Input Arguments

Req

Field Name

Field Type

Max Length

Description

client_no

long

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

auth_key

string

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

plan_no

int

100

Plan Number

client_plan_id

string

100

Client defined unique identifier

include_rs_summary

string

Boolean - true/false. Summary level rate schedule information for all the rate schedules that are associated with a particular plan.

retrieve_bundled_nso

string

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

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

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

locale_name

string

Name of the locale to which the translations belong.

include_translations

string

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

Allowable values for include_translations:

Values	Description
true	Translated fields will be fetched in all the locales defined.
false	Translation information will not be fetched.

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_months

string

Specifies rollover months. Valid values are from 0 to 36

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 for rollover_plan_uom_cd:

Values	Description
1	Day
2	Week
3	Month
4	Quarter
5	Year

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 for init_free_period_uom_cd:

Values	Description
1	Day
2	Week
3	Month
4	Quarter
5	Year

initial_plan_status_cd

int

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

Allowable values for initial_plan_status_cd:

Values	Description
1	Active
31	Pending Installation
32	Pending Activation
41	Trial
61	Active Non-Billable

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 for rollover_plan_status_uom_cd:

Values	Description
1	Day
2	Week
3	Month
4	Quarter
5	Year

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

free_trial_duration

int

Specifies free trial duration.Valid values are from 0 to 99

free_trial_type

int

Specifies free trial duration.Valid values are : "days" or "months"

initial_free_months

int

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

service_name

service_type

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

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

recurring_billing_period_type

int

Recurring Billing Period Type can be either of 1, 2, 3

usage_billing_interval

int

Usage billing interval

usage_billing_period_type

int

Usage Billing Period Type can be either of 1, 2, 3

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 for active_ind:

Values	Description
0	Inactive
10	Active

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 for item_scope:

Values	Description
U	Up to Plan Units.
M	Match Plan Units.
A	Any Units.

plan_nso_price_override

hash

Overridden prices for NSO items.

rate_schedule_no

long

The internal Id of the rate schedule (DEPRECATED; use list_rate_schedule_no)

client_rate_schedule_id

string

Client assigned unique rate schedule number (DEPRECATED; use client_list_rate_schedule_id)

currency_cd

string

Currency code for Inventory item.

override_price

string

Overridden price for Inventory item for currencies.

bundle_nso_rate_schedule_no

int

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

Client-defined unique identifier for the rate schedule to be used as the bundle price for the NSO when purchased with this plan.

installment terms

installment_term_no

long

Aria-assigned unique identifier for client installment term.

client_installment_term_id

string

Specifies client installment term id.

installment_term_name

string

Specifies installment term name.

is_default

int

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. Alternative boolean values are accepted.

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 for active_ind:

Values	Description
0	Inactive
10	Active

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

currency_cd

string

Currency code for Inventory item.

override_price

string

Overridden price for Inventory item for currencies.

bundle_nso_rate_schedule_no

string

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

Client-defined unique identifier for the rate schedule to be used as the bundle price for the NSO when purchased with this plan.

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 for nso_group_item_scope:

Values	Description
U	Up to Plan Units.
M	Match Plan Units.
A	Any Units.

nso_incl_list_scope

int

Scope of additional NSO as part of inclusion list.

Allowable values for nso_incl_list_scope:

Values	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

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 for active_ind:

Values	Description
0	Inactive.
1	Active.

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

Input Arguments

Allowable values for include_translations:

Output Arguments

Allowable values for rollover_plan_uom_cd:

Allowable values for init_free_period_uom_cd:

Allowable values for initial_plan_status_cd:

Allowable values for rollover_plan_status_uom_cd:

Allowable values for active_ind:

Allowable values for item_scope:

Allowable values for active_ind:

Allowable values for nso_group_item_scope:

Allowable values for nso_incl_list_scope:

Allowable values for active_ind: