Search the Aria Knowledgebase for
User Documentation, APIs, SDKs, and more!

 

Home > Aria Crescendo core api > get_acct_plan_history_m

get_acct_plan_history_m

Returns a list of plan changes (including assignments, replacements, status changes, etc.) for the specified account.

Input Arguments

Req Field Name Field Type Max Length Description
client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
auth_key string 32 Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.
acct_no long 22 Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
filter_plan_instance_no long 22 The Master Subscription plan instance number.
OR
filter_client_plan_instance_id string 100 Client-defined Master plan Subscription plan instance ID.
locale_no long 22 Aria-assigned unique identifier of the locale used for translations. This value must be unique across all Aria clients.
OR
locale_name string 50 Name of the locale.
alt_caller_id string 30 Person or process that submitted the API call. This can be someone's user ID, or the name of an application.
optional_transaction_qualifiers array Array of additional values you can associate with this API call.
qualifier_name string 100 Name of the field you want to associate with this API call.
qualifier_value string 100 Corresponding value of the field you want to associate with this API call.

Output Arguments

Field Name Field Type Description
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.
plan_history hash
plan_instance_no long Unique plan instance number for each assigned master plan.
master_plan_instance_no long Aria generated unique identifier for the master plan instance.
old_plan_no long Aria-assigned unique plan identifier
new_plan_no long Aria-assigned unique plan identifier
old_client_plan_id string Client assigned unique plan identifier
new_client_plan_id string Client assigned unique plan identifier
old_plan_name string The name of the plan this line represents
new_plan_name string The name of the plan this line represents
old_promo_cd string 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 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 Master plan instance status   Allowable Values
new_status_cd long Master plan instance status   Allowable Values
old_plan_units double A string array of old plan unit values assigned to the plans listed in plan no
new_plan_units double A string array of new plan units associated with the list of plans provided by plan_no
old_rate_schedule_no long A string array of old rate schedules associated with the plans listed in plan_no
new_rate_schedule_no long A string arrray of new rate schedules associated with the plans listed in plan_no
old_client_rate_schedule_id string 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 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 Unique client-defined ID for each assigned master plan.
new_client_plan_instance_id string Unique client-defined ID for each assigned master plan.
update_date string A string array of dates representing the last update to the plans corresponding to the list provided in plan_no.
old_dunning_state long Previous dunning state of the plan instance.
new_dunning_state long Current dunning state of the plan instance.
acct_locale_no long Aria-assigned unique identifier of the locale used for translations. This value is unique across all Aria-managed accounts.
acct_locale_name string Name of the account level locale.

You must to post a comment.
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.