| 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. |
| acct_plans_m |
hash |
|
 plan_no |
long |
Aria-assigned unique Plan identifier |
| plan_name |
string |
Plan Name |
| plan_desc |
string |
Text description of this Plan |
| plan_instance_no |
long |
Unique Plan instance number for each assigned Master Plan. |
| client_plan_instance_id |
string |
Unique client-defined ID for each assigned Master Plan. |
| plan_date |
string |
Date on which the account was assigned to their current Plan. |
| plan_units |
long |
Number of Plan units the account is billed for. |
| last_bill_date |
string |
The date the account was last billed |
| next_bill_date |
string |
Date the account will be evaluated for invoicing, whether or not it results in any actual charges. |
| bill_thru_date |
string |
Date the accounts forward charges have been billed through. |
| bill_day |
long |
Day of the month that the account is billed. |
| recurring_billing_interval |
long |
Number of months between billing cycles |
| usage_billing_interval |
long |
Number of months between billing cycles |
| billing_ind |
long |
Indicates whether or not this Plan is billable
Allowable values for billing_ind:
| Values |
Description |
| 0 |
0 |
| 1 |
1 |
|
| display_ind |
long |
Indicates whether or not the Plan is marked as "displayable". 0 means not displayable. 1 means displayable.
Allowable values for display_ind:
| Values |
Description |
| 0 |
Not displayable |
| 1 |
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. |
| initial_plan_status |
long |
Default status used when Master Plan is initially assigned on an account.
Allowable values for initial_plan_status:
| 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 |
long |
Status used for the Master Plan Instance at the completion of the rollover period.
Allowable values for rollover_plan_status:
| 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_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 |
|
| 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 |
|
| 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 |
|
| 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_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_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. |
| rate_schedule_no |
long |
Aria-assigned unique rate schedule number |
| rate_schedule_name |
string |
Name of the rate schedule |
| rate_sched_is_default_ind |
long |
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.
Allowable values for rate_sched_is_default_ind:
| Values |
Description |
| 0 |
Alternate rate schedule |
| 1 |
Default rate schedule |
|
| supp_plan_ind |
long |
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.
Allowable values for supp_plan_ind:
| Values |
Description |
| 0 |
Master Plan |
| 1 |
Supplemental Plan |
|
| plan_instance_status_cd |
long |
Current status code of the Plan instance.
Allowable values for plan_instance_status_cd:
| 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 |
string |
Current status of the Plan instance.
Allowable values for plan_instance_status_label:
| 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 |
|
| plan_instance_status_date |
string |
Most recent date on which the status of the Plan instance changed. |
| dunning_state |
long |
Current dunning state of the Plan instance (applicable only for Master Plans).
Allowable values for dunning_state:
| Values |
Description |
| 0 |
None |
| 1 |
In Progress |
|
| dunning_step |
long |
Current dunning step of the Plan instance (applicable only for Master Plans currently in dunning). |
| dunning_degrade_date |
string |
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 |
The date on which the current Plan was assigned on this Plan instance. |
| plan_deprovisioned_date |
string |
The date on which the current Plan on this Plan instance was suspended, cancelled or terminated. |
| client_receipt_id |
string |
Client-defined unique identifier used to track related system actions |
| 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_2_assign_on_susp |
string |
Client-defined Plan identifier to assign when an account on this Plan is suspended. |
| client_rate_schedule_id |
string |
Client assigned unique rate schedule number |
| proration_invoice_timing_cd |
string |
Indicates whether to defer the pro-rated charges to the next anniversary date or to create a separate 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. |
|
| master_plan_instance_no |
long |
Master Plan Instance number for each Supplemental Plan. |
| client_master_plan_instance_id |
string |
Client Master Plan Instance ID for each Supplemental Plan. |
| parent_plan_instance_no |
long |
Parent Plan instance number to identify each Supplemental Plan and child Supplemental Plan hierarchy. |
| client_parent_plan_instance_id |
string |
Client parent Plan instance ID to identify each Supplemental Plan and child Supplemental Plan hierarchy. |
| 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_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 |
| po_num |
string |
Purchase order number assigned to the Plan instance. |
| available_from_dt |
string |
Start date of assigned rate schedule |
| available_to_dt |
string |
End date of assigned rate schedule |
| followup_rs_no |
long |
Aria internal ID of follow-up default rate schedule for the assigned rate schedule |
| client_followup_rs_id |
string |
Client-defined ID of followup rate schedule for the assigned rate schedule |
| usage_accumulation_reset_months |
long |
The number of reset months for each Plan. |
|
usage_accumulation_reset_
months_renewal_option
|
long |
Determines whether the usage accumulation reset months will automatically reset to same value at the end of the current period or will expire at the end of the current period.
Allowable values for usage_accumulation_reset_months_ renewal_option:
| Values |
Description |
| NULL or 1 |
Recurring / Auto Renew.(Default) |
| 2 |
Single Use. |
|
| usage_accumulation_reset_counter |
long |
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 |
Bill lag days refer to the number of days prior to (negative) or after (positive) an account billing date at which you specified that an invoice should be generated for a Master Plan Instance.
Examples:
- -14 means that an invoice is generated 14 days before the billing date.
- 10 means that an invoice is generated 10 days after the billing date.
|
| acct_locale_no |
long |
Aria-assigned Locale identifier. This value is unique across all Aria-managed accounts. DEPRECATED |
| acct_locale_no_2 |
long |
Aria-assigned Locale identifier. This value is unique across all Aria-managed accounts. |
| acct_locale_name |
string |
Name of the account level locale. |
