Home > Aria6 User Documentation > Aria6 core api > get_master_plans_by_supp_field
get_master_plans_by_supp_field
get_master_plans_by_supp_field
Table of contents
Returns the master plans associated with a particular value for a supplemental object field.
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. |
|
field_no | long | The plan supplemental field number which is being searched against | |
| OR | ||||
| field_name | string | 300 | The optional name of this supplemental field, if the number is not known | |
|
field_val | string | 1000 | The value of the supplemental field which all returned plans should possess |
Output Arguments
| Field Name | Field Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| master_plans_by_supp_field | hash | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
 plan_no |
long | The unique ID of this plan | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| plan_name |
string | The short name of this plan | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| plan_desc |
string | The long description of this plan | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| billing_interval |
long | The interval at which this plan appears on invoices | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| billing_ind |
long | Whether or not this plan is currently billable
Allowable values for billing_ind
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| display_ind |
long | Whether or not this plan is to be displayed to the end-users
Allowable values for display_ind
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| rollover_months |
long | Number of months in which the account will change from the current plan to the pre-defined rollover plan. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| early_cancel_fee |
double | Fee charged for early cancellations. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| early_cancel_min_months |
long | Number of months during which early cancellation fees would apply on plan cancellation. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| new_acct_status |
long | The status code to assert for the new account.
Allowable values for new_acct_status
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| rollover_acct_status |
long | Default status for new accounts created on this plan.
Allowable values for rollover_acct_status
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| init_free_months |
long | Initial free months. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| plan_2_assign_on_susp |
long | Plan to assign when an account on this plan is suspended. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| default_notify_method |
long | Default notification method given to an account that is assigned to this plan.
Allowable values for default_notify_method
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| prepaid_ind |
long | Indicates whether or not this plan is prepaid
Allowable values for prepaid_ind
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| currency_cd |
string | The 3-character ISO-compliant currency code in lowercase for monetary values used in the context of this API method. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| client_plan_id |
string | Client-defined Plan ID for which to query available child plans | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| client_plan_id_2_assign_on_susp |
string | Client-defined Plan ID to assign when an account on this plan is suspended. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| proration_invoice_timing_cd |
string | Indicates whether to defer the pro-rated charges to the next anniversary date or to create a seperate invoice immediately.
Allowable values for proration_invoice_timing_cd
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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. |
- © Copyright 2023 Aria Developer Central