Home > Aria Crescendo Documentation > 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
required-icon.png client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
required-icon.png auth_key string 32 Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.
required-icon.png 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.
required-icon.png queued_action_status_cd long 1 Filters the list of queued plan changes returned based on the status code  

Allowable values for queued_action_status_cd:

Values Description
0 Deleted
1 Queued
2 Executed successfully
3 Failed to execute
4 All (default if no value is provided)
  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.
  brd_arrow.gif qualifier_name string 100 Name of the field you want to associate with this API call.
  brd_arrow.gif 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  
brd_arrow.gif queue_id long Unique identifier associated with a specific queued plan change
brd_arrow.gif plan_instance_no long The unique identifier of the plan instance
brd_arrow.gif client_plan_instance_id string The client-defined identifier of the plan instance
brd_arrow.gif parent_plan_instance_no long The unique identifier of the parent plan instance.
brd_arrow.gif client_parent_plan_instance_id string The client-defined identifier of the parent plan instance.
brd_arrow.gif queued_action_status_cd long The current status code associated with a queued plan change  

Allowable values for queued_action_status_cd:

Values Description
0 Deleted
1 Queued
2 Executed successfully
3 Failed to execute
brd_arrow.gif queued_action_status_label string The current status associated with a queued plan change  

Allowable values for queued_action_status_label:

Values Description
0 Deleted
1 Queued
2 Executed successfully
3 Failed to execute
brd_arrow.gif current_plan_no long Unique identifier of the plan currently associated with the plan instance
brd_arrow.gif current_client_plan_id string Client-defined identifier of the plan currently associated with the plan instance
brd_arrow.gif current_plan_name string Name of the plan currently associated with the plan instance
brd_arrow.gif current_plan_units long Number of plan units currently associated with the plan instance.
brd_arrow.gif current_plan_inst_status long Status currently associated with the plan instance.  DEPRECATED  

Allowable values for current_plan_inst_status:

Values Description
1 ACTIVE
2 PENDING CANCELLATION
3 PENDING TERMINATION
31 PENDING INSTALLATION
32 PENDING ACTIVATION
41 TRIAL
61 ACTIVE NON-BILLABLE
-1 SUSPENDED
-2 CANCELLED
-3 TERMINATED
0 INACTIVE
brd_arrow.gif current_plan_inst_status_2 long Status currently associated with the plan instance. 

Allowable values for current_plan_inst_status_2:

Values Description
1 ACTIVE
2 PENDING CANCELLATION
3 PENDING TERMINATION
31 PENDING INSTALLATION
32 PENDING ACTIVATION
41 TRIAL
61 ACTIVE NON-BILLABLE
-1 SUSPENDED
-2 CANCELLED
-3 TERMINATED
0 INACTIVE
brd_arrow.gif current_rate_schedule_no long Unique identifier of the rate schedule currently associated with the plan instance.
brd_arrow.gif current_client_rate_schedule_id string Client-defined identifier of the rate schedule currently associated with the plan instance
brd_arrow.gif effective_date string Date on which the queued plan change will take effect in the following format: YYYY-MM-DD HH24:MI:SS
brd_arrow.gif target_plan_no long Unique identifier of the plan that will be associated with the plan instance after the queued plan change takes effect.
brd_arrow.gif 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.
brd_arrow.gif target_plan_name string Name of the plan that will be associated with the plan instance after the queued plan change takes effect
brd_arrow.gif target_plan_units long Number of plan units that will be associated with the plan instance after the queued plan change takes effect
brd_arrow.gif target_plan_inst_status long Status of the plan instance after the queued plan change takes effect. DEPRECATED
brd_arrow.gif target_plan_inst_status long Status of the plan instance after the queued plan change takes effect.
brd_arrow.gif 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
brd_arrow.gif 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
brd_arrow.gif queuing_user_id string User ID that created the queued plan change.
brd_arrow.gif queuing_date string Date on which the queued plan change was created in the following format: YYYY-MM-DD HH24:MI:SS
brd_arrow.gif deleting_user_id string User ID that deleted the queued plan change
brd_arrow.gif deleting_date string Date on which the queued plan change was deleted in the following format: YYYY-MM-DD HH24:MI:SS
brd_arrow.gif execute_immediately_user_id string User ID that immediately executed the queued plan change
brd_arrow.gif execute_immediately_date string Date on which the queued plan change was immediately executed in the following format: YYYY-MM-DD HH24:MI:SS
brd_arrow.gif editing_user_id string User ID that most recently edited the queued plan change
brd_arrow.gif 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
  brd_arrow.gif custom_rate_service_no long The service number of the new custom rate
  brd_arrow.gif client_custom_rate_service_id string The client-defined service ID for the new custom rate
  brd_arrow.gif custom_rate_seq_no long The sequence number of this line of the rate schedule
  brd_arrow.gif custom_rate_from_unit double For tiered pricing, this is the lowest number of units within a tier
  brd_arrow.gif custom_rate_to_unit double For tiered pricing, this is the highest number of units within a tier
  brd_arrow.gif 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.
Powered by CXone Expert ®