Skip to main content
Aria Knowledge Central

get_acct_plans_m Guide

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

API Specification:

get_acct_plans_m

Required Fields:
  • <client_no>
  • <auth_key>
  • <acct_no> or <client_acct_id>

Error Codes

Error Code/Description Associated Inputs

1001: unexpected error


 

1004: authentication error

Associated Inputs: auth_key, client_id, client_no


<auth_key>, <client_no>

1009: account does not exist, Account not found: AriaNo (acct_no), Account not found: Userid (userid), or Account not found: ClientId (client_acct_id)

Associated Inputs: acct_no, account_no, client_acct_id, user_id, userid, parent_acct_no


 

<acct_no>, <client_acct_id>

1067: Locale no does not exist in the system.

Associated Inputs: locale_no, master_plan_instance_no


 

<locale_no>, <master_plan_instance_no>

1066: Locale name does not exist in the system.

Associated Inputs: locale_name


 

<locale_name>

Additional Guidance:

Output Fields

Field Name Notes
<billing_ind>
Allowable values
Values Description
0 0
1 1
<display_ind>
Allowable values
Values Description
0 Not displayable
1 displayable
<initial_plan_status>
Allowable values
Values Description
1 Active
2 Pending Cancellation
3 Pending Termination
31 Pending Installation
32 Pending Activation
41 Trial
61 Active Non-billable
0 Inactive
-1 Suspended
-2 Cancelled
-3 Terminated
<rollover_plan_status>
Allowable values
Values Description
1 Active
2 Pending Cancellation
3 Pending Termination
31 Pending Installation
32 Pending Activation
41 Trial
61 Active Non-billable
0 Inactive
-1 Suspended
-2 Cancelled
-3 Terminated
<rollover_plan_status_uom_cd>
Allowable values
Values Description
1 Day
2 Week
3 Month
4 Quarter
5 Year
<init_free_period_uom_cd>
Allowable values
Values Description
1 Day
2 Week
3 Month
4 Quarter
5 Year
<rollover_plan_uom_cd>
Allowable values
Values Description
1 Day
2 Week
3 Month
4 Quarter
5 Year
<initial_plan_status_cd>
Allowable values
Values Description
1 ACTIVE
41 ACTIVE TRIAL
61 ACTIVE NON-BILLABLE
<rollover_plan_status_cd>
Allowable values
Values Description
1 ACTIVE
41 ACTIVE TRIAL
61 ACTIVE NON-BILLABLE
<default_notify_method>
Allowable values
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
<prepaid_ind>
Allowable values
Values Description
0 0
1 1
<rate_sched_is_default_ind>
Allowable values
Values Description
0 Alternate rate schedule
1 Default rate schedule
<supp_plan_ind>
Allowable values
Values Description
0 Master Plan
1 Supplemental Plan
<plan_instance_status_cd>
Allowable values
Values Description
-3 Terminated
-2 Cancelled
-1 Suspended
0 Inactive
1 Active
2 Pending Cancellation
3 Pending Termination
31 Pending Installation
32 Pending Activation
41 Trial
61 Active Non-billable
<plan_instance_status_label>
Allowable values
Values Description
Terminated Terminated
Cancelled Cancelled
Suspended Suspended
Inactive Inactive
Active Active
Pending Cancellation Pending Cancellation
Pending Termination Pending Termination
Pending Installation Pending Installation
Pending Activation Pending Activation
Trial Trial
Active Non-billable Active Non-billable
<dunning_state>
Allowable values
Values Description
0 None
1 In Progress
<proration_invoice_timing_cd>
Allowable values
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.

<usage_accumulation_reset_months_renewal_option>

Allowable values
Values Description
NULL or 1 Recurring / Auto Renew.(Default)
2 Single Use.

 

  • Was this article helpful?