Skip to main content
Aria Knowledge Central

get_client_plans_basic_m

  1. Last updated
  2. Save as PDF

Summary

API Name get_client_plans_basic_m
Class system_services_m
Update Version 6.45

Description

Returns a summary list of all plans associated with a client.

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

The unique plan identifier, if only one plan is desired.

Alternative field: client_plan_id
client_plan_id string 100 No

Client-defined Plan ID for which to query available child plans

Alternative field: plan_no
include_rs_summary string   No

If set to "true", will retrieve summary level rate schedule information for all the rate schedules that are associated with a particular plan. If left blank, will default to "false".

Allowed values:

Value Description
True  
False  
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
include_translations string   No

Setting this flag as True will fetch the translated fields in all the locales defined. If not passed it defaults to False.

Allowed values:

Value Description
True  
False  

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.
plan_details object   No

See fields below

plan_details.plan_rate_schedules_details fields

Name Type Length Required Description
schedule_no long   No

The ID of this rate schedule
client_rate_schedule_id string 100 No

Client assigned unique rate schedule number
schedule_name string   No

The name of this rate schedule
schedule_currency string   No

The currency this rate schedule is linked to
recurring_billing_interval long   No

Number of months between billing cycles for recurring
usage_billing_interval long   No

Number of months between billing cycles for usage
recurring_billing_period_type long   No

Period type for billing cycles for recurring

Allowed values:

Value Description
1 Period type for recurring billing cyle is Daily
2 Period type for recurring billing cyle is Weekly
3 Period type for recurring billing cyle is Monthly
4 Period type for recurring billing cyle is Quarterly
5 Period type for recurring billing cyle is Yearly
usage_billing_period_type long   No

Period type for billing cycles for usage

Allowed values:

Value Description
1 Period type for usage billing cyle is Daily
2 Period type for usage billing cyle is Weekly
3 Period type for usage billing cyle is Monthly
4 Period type for usage billing cyle is Quarterly
4 Period type for usage billing cyle is Yearly
default_ind long   No

If true, this is the default rate schedule for the default currency

Allowed values:

Value Description
0 Rate schedule is not the default.
1 Rate schedule is the default.
default_ind_curr long   No

If true, this is the default rate schedule for the specified currency

Allowed values:

Value Description
0 Rate schedule is not default for specified currency.
1 Rate schedule is default for specified currency.
schedule_display_ind long   No

Determines whether the rate schedule is displayable

Allowed values:

Value Description
0 Rate schedule is not displayable.
1 Rate schedule is displayable.
available_from_dt string 100 No

Start date of rate schedule
available_to_dt string 100 No

End date of rate schedule
followup_rs_no long 100 No

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

Client-defined ID of followup rate schedule

plan_details.contract_rollover_rate_sched fields

Name Type Length Required Description
contract_current_rate_sched_no long   No

Current rate schedule for which the rollover rate schedule will be used at the completion of the contract
contract_current_client_rate_sched_id string   No

Client-defined ID of the current rate schedule for which the rollover rate schedule will be used at the completion of the 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

plan_details.plan_translation_info fields

Name Type Length Required Description
plan_no long 22 No

Aria-assigned plan identifier. This value is unique across all Aria-managed accounts.
locale_name string 100 No

Name of the locale.
plan_name     No  
plan_desc     No  
locale_no long 30 No

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

plan_details fields

Name Type Length Required Description
plan_no long 22 No

The unique ID of this plan
plan_name string   No

The short name of this plan
plan_desc string   No

The long description of this plan
supp_plan_ind long   No

Whether or not this is a supplemental plan. If not, it is a master plan

Allowed values:

Value Description
0 Master plan
1 Supp plan
billing_ind long   No

Whether or not this plan is currently billable

Allowed values:

Value Description
0  
1  
display_ind long   No

Whether or not this plan is to be displayed to the end-users

Allowed values:

Value Description
0 Displayable
1 Non 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.
new_acct_status long   No

The status code to assert for the new 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_acct_status long   No

Default status for new accounts created on this plan.

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

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   No

Initial free months.
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.
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_id_2_assign_on_susp string 100 No

Client-defined Plan ID to assign when an account on this plan is suspended.
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.
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
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
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_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
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_rate_schedules_details object   No

An array of the rate schedules for the requested plan

See fields below
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 object   No

See fields below
plan_translation_info object   No

See fields below
TOP
  1. Back to top
  • Was this article helpful?

Recommended articles

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