Home > Aria6 User Documentation > Aria6 core api > get_acct_plans

get_acct_plans

Returns the details of the master and supplemental plans most recently assigned to a specified account.

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 acct_no long 22 Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
  alt_caller_id string 30 Person or process that submitted the API call. This can be someone's user ID, or the name of an application.
  optional_transaction_qualifiers array   Array of additional values you can associate with this API call.
  brd_arrow.gif qualifier_name string 100 Name of the field you want to associate with this API call.
  brd_arrow.gif qualifier_value string 100 Corresponding value of the field you want to associate with this API call.
 

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.
acct_plans hash  
brd_arrow.gif plan_no long Aria-assigned unique plan identifier
brd_arrow.gif plan_name string Plan Name
brd_arrow.gif plan_desc string Text description of this plan
brd_arrow.gif plan_date string Date on which the account was assigned to their current plan.
brd_arrow.gif plan_units long Number of plan units the account is billed for.
brd_arrow.gif queued_plan_units long Number of plan units the account is queued to change to on "units_change_date".
brd_arrow.gif units_change_date string The date queued units are effective
brd_arrow.gif last_bill_date string The date the account was last billed
brd_arrow.gif next_bill_date string Date the account will be evaluated for invoicing, whether or not it results in any actual charges.
brd_arrow.gif bill_thru_date string Date the accounts forward charges have been billed through.
brd_arrow.gif bill_day long Day of month the account is billed on.
brd_arrow.gif billing_interval long Number of months between billing cycles
brd_arrow.gif billing_ind long Indicates whether or not this plan is billable 

Allowable values for billing_ind:

brd_arrow.gif display_ind long Indicates whether or not the plan is marked as "displayable". 0 means not displayable. 1 means displayable. 

Allowable values for display_ind:

brd_arrow.gif rollover_months long Number of months in which the account will change from the current plan to the pre-defined rollover plan.
brd_arrow.gif 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.
brd_arrow.gif early_cancel_fee double Fee charged for early cancellations.
brd_arrow.gif early_cancel_min_months long Number of months during which early cancellation fees would apply on plan cancellation.
brd_arrow.gif 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.
brd_arrow.gif new_acct_status long The status of new accounts subscribing to this plan 

Allowable values for new_acct_status:

brd_arrow.gif rollover_acct_status long Default status for new accounts created on this plan. 

Allowable values for rollover_acct_status:

brd_arrow.gif 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.
brd_arrow.gif init_free_months long Initial free months.
brd_arrow.gif plan_2_assign_on_susp long Plan to assign when an account on this plan is suspended.
brd_arrow.gif default_notify_method long Default notification method given to an account that is assigned to this plan. 

Allowable values for default_notify_method:

brd_arrow.gif prepaid_ind long Indicates whether or not this plan is prepaid 

Allowable values for prepaid_ind:

brd_arrow.gif currency_cd string The 3-character ISO-compliant currency code in lowercase for monetary values used in the context of this API method.
brd_arrow.gif rate_schedule_no long Aria-assigned unique rate schedule number
brd_arrow.gif rate_schedule_name string Name of the rate schedule
brd_arrow.gif rate_sched_is_default_ind long Indicates whether or not the account is using the plans default rate schedule. 0 means the account is using an alternate rate schedule. 1 means the account is using the default rate schedule. 

Allowable values for rate_sched_is_default_ind:

brd_arrow.gif available_from_date string Start date of rate schedule
brd_arrow.gif available_to_date string End date of rate schedule
brd_arrow.gif followup_rs_no long Aria internal id of follow-up default rate schedule
brd_arrow.gif client_followup_rs_id string Client defined id of followup rate schedule
brd_arrow.gif supp_plan_ind long Indicates whether or not the plan is a supplemental plan. If it is "1", then the plan is a supplemental plan and if it is "0", then the plan is a master plan. 

Allowable values for supp_plan_ind:

brd_arrow.gif supp_plan_status_cd long The status code of the supplemental plan associated with this account. 

Allowable values for supp_plan_status_cd:

brd_arrow.gif supp_plan_status_label string The status code of the supplemental plan returned by the API method. 

Allowable values for supp_plan_status_label:

brd_arrow.gif supp_plan_status_date string The date of the most recent status change on the account due to this supplemental plan
brd_arrow.gif supp_plan_activate_date string The activation date of this supplemental plan
brd_arrow.gif supp_plan_terminate_date string The termination date, if any, of this supplemental plan
brd_arrow.gif client_receipt_id string Client-defined unique identifier used to track related system actions
brd_arrow.gif client_plan_id string Client-defined Plan ID for which to query available child plans
brd_arrow.gif client_rollover_plan_id string 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 client rollover plan ID.
brd_arrow.gif client_plan_2_assign_on_susp string Client-defined Plan identifier to assign when an account on this plan is suspended.
brd_arrow.gif client_rate_schedule_id string Client assigned unique rate schedule number
brd_arrow.gifproration_invoice_timing_cd string Indicates whether to defer the pro-rated charges to the next anniversary date or to create a separate invoice immediately. 

Allowable values for proration_invoice_timing_cd:

brd_arrow.gifusage_accumulation_reset_months long For each plan specified, the number of months to accumulate before being reset.
brd_arrow.gifusage_accumulation_reset_months_renewal_option long Determines whether the usage accumulation reset months will automatically reset to same value at the end of the current period or will expire at the end of the current period.  

Allowable values for usage_accumulation_reset_months_ renewal_option:

brd_arrow.gifusage_accumulation_reset_counter long Number of months since last reset. Once this this value reaches the <usage_accumulation_reset_months> value, it will reset to 0 (zero)
 
 
 
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.