Home > Aria6 User Documentation > Aria6 admintools api > get_plan_details


Returns details for specified service plan

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.
required-icon.png plan_no int 100 Plan Number
  client_plan_id string 100 Client defined unique identifier

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  
brd_arrow.gif plan_group int Plan Group Number
plan_group_ids hash  
brd_arrow.gif plan_group_id string Client defined unique identifier
currency_cd string Specifies the currency code of plan
billing_interval int Billing Interval [ can be either of 1, 3, 6 or 12 ) 1 - Monthly 3 - Quarterly 6 - Semi-Annually 12 - Annually
usage_billing_interval string  
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_no int Plan number
rollover_client_plan_id string Client defined identifier for rollover plan number
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  
brd_arrow.gif service_no int Service number
brd_arrow.gif client_service_id string Client defined identifier for service
parent_plans hash  
brd_arrow.gif parent_plan int Plan Number of parent plan
parent_plan_ids hash  
brd_arrow.gif parent_plan_id string Client defined identifier for parent plan
exclusion_plans hash  
brd_arrow.gif exclusion_plan int Exclusion Plan Number
resources hash  
brd_arrow.gif resources int  
brd_arrow.gif resource_type_no int Resource Type number
brd_arrow.gif resource_units int No. of units
brd_arrow.gif expire_on_paid_through int Expires on paid through data
brd_arrow.gif reset_on_update int  
brd_arrow.gif add_days_to_expiry int  
supplemental_obj_fields hash  
brd_arrow.gif field_no int the field no
brd_arrow.gif field_value string the field value
brd_arrow.gif field_name string the field name
surcharges hash  
brd_arrow.gif surcharge_no hash  
brd_arrow.gif surcharge_nos int Specifies the surcharge_no associated with this plan.
brd_arrow.gif client_surcharge_id hash  
brd_arrow.gif 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.
Last modified


This page has no custom tags.


This page has no classifications.