Skip to main content
Aria Knowledge Central

get_acct_plans_m

  1. Last updated
  2. Save as PDF

Summary

API Name get_acct_plans_m
Class account_services_m
Update Version 17

Description

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

Inputs

Name Type Length Required Description
client_no long 22 Yes

Aria-assigned unique identifier indicating the Aria client providing service to this account.
auth_key string 32 No

Aria-assigned unique key for authenticating the validity of the requestor. This key is passed with each method call.
acct_no long 22 Yes

Aria-assigned account identifier. This value is unique across all Aria-managed accounts.

Alternative required field: client_acct_id
locale_no long 30 No

Aria-assigned unique identifier of the locale used for translations. This value must be unique across all Aria clients.

Alternative field: locale_name
locale_name string 100 No

Name of the locale.

Alternative field: locale_no
client_acct_id string 50 Yes

Client-defined account identifier.

Alternative required field: acct_no

Outputs

Name Type Length Required Description
error_code long   No

Aria-assigned error identifier. 0 indicates no error.
error_msg string   No

Description of any error that occurred. "OK" if there was no error.
acct_plans_m object   No

See fields below
acct_locale_no long 30 No

Note: This field is deprecated. Aria no longer supports acct_locale_no.
acct_locale_name string 100 No

Name of the account level locale.
acct_locale_no_2 long 30 No

Aria-assigned unique identifier of the locale used for translations. This value is unique across all Aria-managed accounts.

acct_plans_m fields

Name Type Length Required Description
plan_no long 22 No

Aria-assigned unique plan identifier
plan_name string   No

Plan Name
plan_desc string   No

Text description of this plan
plan_instance_no long   No

Unique plan instance number for each assigned master plan.
client_plan_instance_id string 100 No

Unique client-defined ID for each assigned master plan.
plan_date string   No

Date on which the account was assigned to their current plan.
plan_units long   No

Number of plan units the account is billed for.
last_bill_date string   No

The date the account was last billed
next_bill_date string   No

Date the account will be evaluated for invoicing, whether or not it results in any actual charges.
bill_thru_date string   No

Date the accounts forward charges have been billed through.
bill_day long   No

Day of the month that the account is billed.
recurring_billing_interval long   No

Number of months between billing cycles
usage_billing_interval long   No

Number of months between billing cycles
recurring_billing_period_type long   No

Period type for billing cycles for recurring
usage_billing_period_type long   No

Period type for billing cycles for usage
billing_ind long   No

Indicates whether or not this plan is billable

Allowed values:

Value Description
0  
1  
display_ind long   No

Indicates whether or not the plan is marked as "displayable". 0 means not displayable. 1 means displayable.

Allowed values:

Value Description
0 Not displayable
1 displayable
rollover_months long   No

Number of months in which the account will change from the current plan to the pre-defined rollover plan.
rollover_plan_no long   No

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   No

Fee charged for early cancellations.
early_cancel_min_months long   No

Number of months during which early cancellation fees would apply on plan cancellation.
suspension_period long   No

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.
initial_plan_status long   No

Default status used when master plan is initially assigned on an account.

Allowed values:

Value Description
0 INACTIVE
1 ACTIVE
2 CANCELLATION PENDING
3 TERMINATION PENDING
10 ACTIVE DUNNING PENDING
11 ACTIVE DUNNING 1
12 ACTIVE DUNNING 1
13 ACTIVE DUNNING 3
14 ACTIVE DUNNING 4
15 ACTIVE DUNNING 5
16 ACTIVE DUNNING 6
17 ACTIVE DUNNING 7
18 ACTIVE DUNNING 8
21 REINSTATED FORWARD BILL
22 REINSTATED BACK BILL
31 INSTALLATION PENDING
32 REGISTERED PENDING ACTIVATION
41 ACTIVE TRIAL
51 TEMPORARY SERVICE BAN
61 ACTIVE NON-BILLABLE
99 PERMANENT
-1 SUSPENDED
-2 CANCELLED
-3 TERMINATED
-4 CONTRACT EXPIRED
-11 SUSPENDED DUNNING 1
-12 SUSPENDED DUNNING 2
-13 SUSPENDED DUNNING 3
-14 SUSPENDED DUNNING 4
-15 SUSPENDED DUNNING 5
-99 ARCHIVED
rollover_plan_status long   No

Status used for the master plan instance at the completion of the rollover period.

Allowed values:

Value Description
0 INACTIVE
1 ACTIVE
2 CANCELLATION PENDING
3 TERMINATION PENDING
10 ACTIVE DUNNING PENDING
11 ACTIVE DUNNING 1
12 ACTIVE DUNNING 1
13 ACTIVE DUNNING 3
14 ACTIVE DUNNING 4
15 ACTIVE DUNNING 5
16 ACTIVE DUNNING 6
17 ACTIVE DUNNING 7
18 ACTIVE DUNNING 8
21 REINSTATED FORWARD BILL
22 REINSTATED BACK BILL
31 INSTALLATION PENDING
32 REGISTERED PENDING ACTIVATION
41 ACTIVE TRIAL
51 TEMPORARY SERVICE BAN
61 ACTIVE NON-BILLABLE
99 PERMANENT
-1 SUSPENDED
-2 CANCELLED
-3 TERMINATED
-4 CONTRACT EXPIRED
-11 SUSPENDED DUNNING 1
-12 SUSPENDED DUNNING 2
-13 SUSPENDED DUNNING 3
-14 SUSPENDED DUNNING 4
-15 SUSPENDED DUNNING 5
-99 ARCHIVED
rollover_plan_status_duration long   No

Duration of the plan status rollover period, after which the initial plan status on the master plan instance will change to the pre-defined rollover plan status (used in conjuction with rollover_plan_status_uom_cd).
rollover_plan_status_uom_cd long   No

Units associated with the duration of the plan status rollover period after which the initial plan status on the master plan instance will change to the pre-defined rollover plan status. (used in conjunction with rollover_plan_status_duration).

Allowed values:

Value Description
1 Day
2 Week
3 Month
4 Quarter
5 Year
init_free_period_duration long   No

Duration of the initial free period (used in conjunction with init_free_period_uom_cd).
init_free_period_uom_cd long   No

Units associated with the duration of the initial free period (used in conjunction with init_free_period_duration).

Allowed values:

Value Description
1 Day
2 Week
3 Month
4 Quarter
5 Year
rollover_plan_duration long   No

Duration of the plan rollover period (used in conjunction with rollover_plan_uom_cd).
rollover_plan_uom_cd long   No

Units associated with the duration of the plan rollover period (used in conjunction with rollover_plan_duration).

Allowed values:

Value Description
1 Day
2 Week
3 Month
4 Quarter
5 Year
initial_plan_status_cd long   No

Default status used when master plan is initially assigned on an account.

Allowed values:

Value Description
1 ACTIVE
41 ACTIVE TRIAL
61 ACTIVE NON-BILLABLE
rollover_plan_status_cd long   No

Status used for the master plan instance at the completion of the plan status rollover period.

Allowed values:

Value Description
1 ACTIVE
41 ACTIVE TRIAL
61 ACTIVE NON-BILLABLE
plan_2_assign_on_susp long   No

Plan to assign when an account on this plan is suspended.
default_notify_method long   No

Default notification method given to an account that is assigned to this plan.

Allowed values:

Value 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 long   No

Indicates whether or not this plan is prepaid

Allowed values:

Value Description
0  
1  
currency_cd string   No

The 3-character ISO-compliant currency code in lowercase for monetary values used in the context of this API method.
rate_schedule_no long   No

Aria-assigned unique rate schedule number
rate_schedule_name string   No

Name of the rate schedule
rate_sched_is_default_ind long   No

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.

Allowed values:

Value Description
0 Alternate rate schedule
1 Default rate schedule
supp_plan_ind long   No

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.

Allowed values:

Value Description
0 Master plan
1 Supplemental plan
plan_instance_status_cd long   No

Current status code of the plan instance.

Allowed values:

Value 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 string   No

Current status of the plan instance.

Allowed values:

Value 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
plan_instance_status_date string   No

Most recent date on which the status of the plan instance changed.
dunning_state long 1 No

Current dunning state of the plan instance (applicable only for master plans).

Allowed values:

Value Description
0 None
1 In Progress
2 Complete
dunning_step long   No

Current dunning step of the plan instance (applicable only for master plans currently in dunning).
dunning_degrade_date string   No

Next future date on which the plan instance would advance to the next dunning step (applicable only for master plans currently in dunning).
plan_assignment_date string   No

The date on which the current plan was assigned on this plan instance.
plan_deprovisioned_date string   No

The date on which the current plan on this plan instance was suspended, cancelled or terminated.
client_receipt_id string 50 No

Client-defined unique identifier used to track related system actions
client_plan_id string 100 No

Client-defined Plan ID for which to query available child plans
client_rollover_plan_id string 100 No

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_2_assign_on_susp string 100 No

Client-defined Plan identifier to assign when an account on this plan is suspended.
client_rate_schedule_id string 100 No

Client assigned unique rate schedule number
proration_invoice_timing_cd string 2 No

Indicates whether to defer the pro-rated charges to the next anniversary date or to create a seperate invoice immediately.

Allowed values:

Value 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.
master_plan_instance_no long 22 No

Master plan instance number for each supplemental plan.
client_master_plan_instance_id string 100 No

Client master plan instance ID for each supplemental plan.
parent_plan_instance_no long 22 No

Parent plan instance number to identify each supplemental plan and child supplemental plan heirarchy.
client_parent_plan_instance_id string 100 No

Client parent plan instance ID to identify each supplemental plan and child supplemental plan heirarchy.
contract_rollover_plan_no long   No

Pre-defined plan to be used as the rollover plan at the completion of the contract.
contract_rollover_client_plan_id string 100 No

Client-defined ID of the pre-defined plan to be used as the rollover plan at the completion of a contract.
contract_rollover_rate_sched_no long   No

Pre-defined rate schedule to be used as the rollover rate schedule at the completion of the contract
contract_rollover_client_rate_sched_id string   No

Client-defined ID of the pre-defined rate schedule to be used as the rollover rate schedule at the completion of the contract
po_num string 100 No

Purchase order number assigned to the plan instance.
available_from_dt string 100 No

Start date of assigned rate schedule
available_to_dt string 100 No

End date of assigned rate schedule
followup_rs_no long 100 No

Aria internal ID of follow-up default rate schedule for the assigned rate schedule
client_followup_rs_id string 100 No

Client-defined ID of followup rate schedule for the assigned rate schedule
usage_accumulation_reset_months long 4 No

The number of reset months for each plan
usage_accumulation_reset_months_renewal_option long 1 No

Determines whether the usage accumulation reset months will automatically reset to same value at the end of the current period or will expire at end of current period.

Allowed values:

Value Description
1 Recurring / Auto-Renew (default)
2 Single Use
usage_accumulation_reset_counter long   No

Number of months since last reset. Once this value reaches the usage_accumulation_reset_months value, it will reset to 0 (zero).
bill_lag_days long 10 No

Bill lag days refer to the number of days prior to (negative) or after (positive) an account billing date at which an invoice should be generated for this Master Plan Instance. Negative bill lag days are typically used for subscription-based services (often subscription-based services paid using net-terms), in which the user would like to send out invoices to customers well in advance of the real invoice date. Positive bill lag days are typically used for usage-based services.
TOP
  1. Back to top
  • Was this article helpful?

Recommended articles

  1. Page type
    Topic
  2. Tags
    This page has no tags.