| 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. |
| master_plans_dtl_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_ind |
long |
Whether or not this Plan is currently billable
Allowable values for billing_ind:
| Values |
Description |
| 0 |
0 |
| 1 |
1 |
|
| 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 |
|
| 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:
| Values |
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 |
Default status for new accounts created on this Plan.
Allowable values for rollover_acct_status:
| Values |
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 |
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:
| 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 |
long |
Indicates whether or not this Plan is prepaid
Allowable values for prepaid_ind:
| Values |
Description |
| 0 |
0 |
| 1 |
1 |
|
| 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:
| 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. |
|
| rollover_plan_duration |
long |
Duration of the Plan rollover period (used in conjunction with rollover_plan_uom_cd). |
| rollover_plan_uom_cd |
long |
Units associated with the duration of the Plan rollover period (used in conjunction with rollover_plan_duration).
Allowable values for rollover_plan_uom_cd:
| Values |
Description |
| 1 |
Day |
| 2 |
Week |
| 3 |
Month |
| 4 |
Quarter |
| 5 |
Year |
|
| init_free_period_duration |
long |
Duration of the initial free period (used in conjunction with init_free_period_uom_cd). |
| init_free_period_uom_cd |
long |
Units associated with the duration of the initial free period (used in conjunction with init_free_period_duration).
Allowable values for init_free_period_uom_cd:
| Values |
Description |
| 1 |
Day |
| 2 |
Week |
| 3 |
Month |
| 4 |
Quarter |
| 5 |
Year |
|
| initial_plan_status_cd |
long |
Default status used when Master Plan is initially assigned on an account.
Allowable values for initial_plan_status_cd:
| Values |
Description |
| 1 |
ACTIVE |
| 41 |
ACTIVE TRIAL |
| 61 |
ACTIVE NON-BILLABLE |
|
| rollover_plan_status_duration |
long |
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 |
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).
Allowable values for rollover_plan_status_uom_cd:
| Values |
Description |
| 1 |
Day |
| 2 |
Week |
| 3 |
Month |
| 4 |
Quarter |
| 5 |
Year |
|
| rollover_plan_status_cd |
long |
Status used for the Master Plan Instance at the completion of the Plan status rollover period.
Allowable values for rollover_plan_status_cd:
| Values |
Description |
| 1 |
ACTIVE |
| 41 |
ACTIVE TRIAL |
| 61 |
ACTIVE NON-BILLABLE |
|
| plan_rate_schedules_details |
hash |
An array of the rate schedules for the requested Plan |
| schedule_no |
long |
The ID of this rate schedule |
| client_rate_schedule_id |
string |
Client assigned unique rate schedule number |
| schedule_name |
string |
The name of this rate schedule |
| schedule_currency |
string |
The currency this rate schedule is linked to |
| recurring_billing_interval |
long |
Number of months between billing cycles for recurring |
| usage_billing_interval |
long |
Number of months between billing cycles for usage |
| recurring_billing_period_type |
long |
Period type for billing cycles for recurring.
Allowable values for recurring_billing_period_type:
| Values |
Description |
| 1 |
Period type for recurring billing cycle is Daily. |
| 2 |
Period type for recurring billing cycle is Weekly. |
| 3 |
Period type for recurring billing cycle is Monthly. |
| 4 |
Period type for recurring billing cycle is Quarterly. |
| 5 |
Period type for recurring billing cycle is Yearly. |
|
| usage_billing_period_type |
long |
Period type for billing cycles for usage.
Allowable values for usage_billing_period_type:
| Values |
Description |
| 1 |
Period type for usage billing cycle is Daily. |
| 2 |
Period type for usage billing cycle is Weekly. |
| 3 |
Period type for usage billing cycle is Monthly. |
| 4 |
Period type for usage billing cycle is Quarterly. |
| 5 |
Period type for usage billing cycle is Yearly. |
|
| default_ind |
long |
If true, this is the default rate schedule for the default currency
Allowable values for default_ind:
| Values |
Description |
| 0 |
Rate schedule is not the default. |
| 1 |
Rate schedule is the default. |
|
| default_ind_curr |
long |
If true, this is the default rate schedule for the specified currency
Allowable values for default_ind_curr:
| Values |
Description |
| 0 |
Rate schedule is not default for specified currency. |
| 1 |
Rate schedule is default for specified currency. |
|
| schedule_display_ind |
long |
Determines whether the rate schedule is displayable
Allowable values for schedule_display_ind:
| Values |
Description |
| 0 |
Rate schedule is not displayable. |
| 1 |
Rate schedule is displayable. |
|
| available_from_dt |
string |
Start date of rate schedule |
| available_to_dt |
string |
End date of rate schedule |
| followup_rs_no |
long |
Aria internal ID of follow-up default rate schedule |
| client_followup_rs_id |
string |
Client-defined ID of followup rate schedule |
| contract_rollover_plan_no |
long |
Pre-defined Plan to be used as the rollover Plan at the completion of the contract. |
| contract_rollover_client_plan_id |
string |
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 |
hash |
|
| contract_current_rate_sched_no |
long |
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 |
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 |
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 |
Client-defined ID of the pre-defined rate schedule to be used as the rollover rate schedule at the completion of the contract |
| plan_translation_info |
hash |
|
| plan_no |
long |
The unique ID of this Plan. |
| locale_name |
string |
Name of the locale. |
| plan_name |
string |
The short name of this Plan. |
| plan_desc |
string |
The long description of this Plan. |
| locale_no |
long |
Aria-assigned unique identifier of the locale used for translations. This value must be unique across all Aria clients. |
| rate_scheds_t |
hash |
|
| schedule_no |
long |
The ID of this rate schedule |
| schedule_name |
string |
The name of this rate schedule |
