Home > Aria6 User Documentation > Aria6 core api > get_supp_plans_by_supp_field

get_supp_plans_by_supp_field

Returns a list of supplemental plans associated with a specified value for a supplemental object field.

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 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
required-icon.png field_val string 1000 The value of the supplemental field which all returned plans should possess
 

Output Arguments

Field Name Field Type Description
supp_plans_by_supp_field hash  
brd_arrow.gif plan_no long The unique ID of this plan
brd_arrow.gif plan_name string The short name of this plan
brd_arrow.gif plan_desc string The long description of this plan
brd_arrow.gif billing_interval long The interval at which this plan appears on invoices
brd_arrow.gif billing_ind long Whether or not this plan is currently billable 

Allowable values for billing_ind

Values Description
0 0
1 1
brd_arrow.gif display_ind long Whether or not this plan is to be displayed to the end-users 

Allowable values for display_ind

Values Description
0 Displayable
1 Non displayable
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 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

Values Description
0 None
1 HTML Email
2 Text Email
3 Text Email w/link to HTML
4 Data export
5 Printable (no Email) w/Surcharge
6 Printable & Text Email
7 Printable & HTML Email w/Surcharge
8 Printable (no Email)
9 PDF (Printing required, no Email)
10 PDF (delivered by Email)
11 PDF (Printing req & Email)w/surcharge
12 PDF (Printing req, no Email)w/surcharge
13 XML Master File
14 PDF Master File
brd_arrow.gif prepaid_ind long Indicates whether or not this plan is prepaid 

Allowable values for prepaid_ind

Values Description
0 0
1 1
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 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_id_2_assign_on_susp string Client-defined Plan ID to assign when an account on this plan is suspended.
brd_arrow.gif 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

Values Description
I Indicates to generate the invoice immediately for the pro-rated charges.
A Indicates to generate the invoice to the next anniversary date for the pro-rated charges.
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.
 
 
 
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.