get_acct_plan_history_m
Summary
| API Name | get_acct_plan_history_m |
|---|---|
| Class | account_services_m |
| Update Version | 34 |
Description
Returns a list of plan changes (including assignments, replacements, status changes, etc.) for the 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 |
| filter_plan_instance_no | long | 22 | No |
The Master Subscription plan instance number. Alternative field: filter_client_plan_instance_id |
| filter_client_plan_instance_id | string | 100 | No |
Client-defined Master plan Subscription plan instance ID. Alternative field: filter_plan_instance_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. 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. |
|
| plan_history | object | No | ||
| 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. |
plan_history fields
| Name | Type | Length | Required | Description | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| plan_instance_no | long | No |
Unique plan instance number for each assigned master plan. |
|||||||||||||||||||||||||
| master_plan_instance_no | long | 22 | No |
Aria generated unique identifier for the master plan instance. |
||||||||||||||||||||||||
| old_plan_no | long | No |
Aria-assigned unique plan identifier |
|||||||||||||||||||||||||
| new_plan_no | long | No |
Aria-assigned unique plan identifier |
|||||||||||||||||||||||||
| old_client_plan_id | string | 100 | No |
Client assigned unique plan identifier |
||||||||||||||||||||||||
| new_client_plan_id | string | 100 | No |
Client assigned unique plan identifier |
||||||||||||||||||||||||
| old_plan_name | string | No |
The name of the plan this line represents |
|||||||||||||||||||||||||
| new_plan_name | string | No |
The name of the plan this line represents |
|||||||||||||||||||||||||
| old_promo_cd | string | 30 | No |
This is the code provided the client and used by the account holder during registration or when executing a transaction. A promotion generally provides access to a custom set of reduced-rate plans. |
||||||||||||||||||||||||
| new_promo_cd | string | 30 | No |
This is the code provided the client and used by the account holder during registration or when executing a transaction. A promotion generally provides access to a custom set of reduced-rate plans. |
||||||||||||||||||||||||
| old_status_cd | long | 8 | No |
Master plan instance status Allowed values:
|
||||||||||||||||||||||||
| new_status_cd | long | 8 | No |
Master plan instance status Allowed values:
|
||||||||||||||||||||||||
| old_plan_units | double | No |
A string array of old plan unit values assigned to the plans listed in plan no |
|||||||||||||||||||||||||
| new_plan_units | double | No |
A string array of new plan units associated with the list of plans provided by plan_no |
|||||||||||||||||||||||||
| old_rate_schedule_no | long | No |
A string array of old rate schedules associated with the plans listed in plan_no |
|||||||||||||||||||||||||
| new_rate_schedule_no | long | No |
A string arrray of new rate schedules associated with the plans listed in plan_no |
|||||||||||||||||||||||||
| old_client_rate_schedule_id | string | 100 | No |
A string array of client-defined old rate schedules ID associated with the plans listed in client_plan_id. |
||||||||||||||||||||||||
| new_client_rate_schedule_id | string | 100 | No |
A string array of client-defined new rate schedules ID associated with the plans listed in client_plan_id. |
||||||||||||||||||||||||
| old_client_plan_instance_id | string | 100 | No |
Unique client-defined ID for each assigned master plan. |
||||||||||||||||||||||||
| new_client_plan_instance_id | string | 100 | No |
Unique client-defined ID for each assigned master plan. |
||||||||||||||||||||||||
| update_date | string | No |
A string array of dates representing the last update to the plans corresponding to the list provided in plan_no. |
|||||||||||||||||||||||||
| old_dunning_state | long | No |
Previous dunning state of the plan instance. Allowed values:
|
|||||||||||||||||||||||||
| new_dunning_state | long | No |
Current dunning state of the plan instance. Allowed values:
|