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



 

Home > Aria Crescendo core api > get_acct_plan_queued_changes_m

get_acct_plan_queued_changes_m

Retrieves all queued plan changes for a given plan instance including plan assignments, removals, replacements and rollovers, as well as changes to plan units, plan instance status, and rate schedules for both master plans and supplemental plans.

For error messages generated by this API, see get_acct_plan_queued_changes_m Error Messages.

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.
  OR      
  client_acct_id string 50

Client-defined account identifier.

To obtain the custom rate details, pass values into these fields:

  • Required: acct_no or client_acct_id
  • Optional: plan_instance_no or client_plan_instance_id, or queue_id.

The custom rate details will be provided
in the queued_plan_custom_rates output
array.

queued_action_status_cd long 1 Filters the list of queued plan changes returned based on the status code   Allowable Values
  queue_id long 22

Unique identifier associated with a specific queued plan (future) change

You can use this API to obtain the rates
that are scheduled to go into effect on a
customer's anniversary date or on the
activation date of a future plan. Pass
values into the acct_no and queue_id
fields to obtain the custom rate details
which will be provided in the queued_plan_custom_rates output
array.

  plan_instance_no long 22 The subscription plan instance number.
  OR      
  client_plan_instance_id string 100 Client-defined plan Subscription plan instance ID.
  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.
queued_change_details hash  
queue_id long Unique identifier associated with a specific queued plan change
plan_instance_no long The unique identifier of the plan instance
client_plan_instance_id string The client-defined identifier of the plan instance
parent_plan_instance_no long The unique identifier of the parent plan instance.
client_parent_plan_instance_id string The client-defined identifier of the parent plan instance.
queued_action_status_cd long The current status code associated with a queued plan change   Allowable Values
queued_action_status_label string The current status associated with a queued plan change   Allowable Values
current_plan_no long Unique identifier of the plan currently associated with the plan instance
current_client_plan_id string Client-defined identifier of the plan currently associated with the plan instance
current_plan_name string Name of the plan currently associated with the plan instance
current_plan_units long Number of plan units currently associated with the plan instance.
current_plan_inst_status long Status currently associated with the plan instance.  DEPRECATED  Allowable Values
 current_plan_inst_status_2 long Status currently associated with the plan instance. Allowable Values
current_rate_schedule_no long Unique identifier of the rate schedule currently associated with the plan instance.
current_client_rate_schedule_id string Client-defined identifier of the rate schedule currently associated with the plan instance
effective_date string Date on which the queued plan change will take effect in the following format: YYYY-MM-DD HH24:MI:SS
target_plan_no long Unique identifier of the plan that will be associated with the plan instance after the queued plan change takes effect.
target_client_plan_id string Client-defined identifier of the plan that will be associated with the plan instance after the queued plan change takes effect.
target_plan_name string Name of the plan that will be associated with the plan instance after the queued plan change takes effect
target_plan_units long Number of plan units that will be associated with the plan instance after the queued plan change takes effect
target_plan_inst_status long Status of the plan instance after the queued plan change takes effect. DEPRECATED
 target_plan_inst_status long Status of the plan instance after the queued plan change takes effect.
target_rate_schedule_no long Unique identifier of the rate schedule that will be associated with the plan instance after the queued plan change takes effect
target_client_rate_schedule_id string Client-defined identifier of the rate schedule that will be associated with the plan instance after the queued plan change takes effect
queuing_user_id string User ID that created the queued plan change.
queuing_date string Date on which the queued plan change was created in the following format: YYYY-MM-DD HH24:MI:SS
deleting_user_id string User ID that deleted the queued plan change
deleting_date string Date on which the queued plan change was deleted in the following format: YYYY-MM-DD HH24:MI:SS
execute_immediately_user_id string User ID that immediately executed the queued plan change
execute_immediately_date string Date on which the queued plan change was immediately executed in the following format: YYYY-MM-DD HH24:MI:SS
editing_user_id string User ID that most recently edited the queued plan change
editing_date string Date on which the queued plan change was most recently edited in the following format: YYYY-MM-DD HH24:MI:SS
queued_plan_custom_rates hash Array of custom rates for a plan assigned to the specified account
holder
  custom_rate_service_no long The service number of the new custom rate
  client_custom_rate_service_id string The client-defined service ID for the new custom rate
  custom_rate_seq_no long The sequence number of this line of the rate schedule
  custom_rate_from_unit double For tiered pricing, this is the lowest number of units within a tier
  custom_rate_to_unit double For tiered pricing, this is the highest number of units within a tier
  custom_rate_per_unit double The rate to charge per unit in this tier
 
 
 
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.