Skip to main content
Aria Knowledge Central

get_acct_plan_queued_changes_m

  1. Last updated
  2. Save as PDF

Summary

API Name get_acct_plan_queued_changes_m
Class account_services_m
Update Version 58

Description

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

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
client_acct_id string 50 Yes

Client-defined account identifier.

Alternative required field: acct_no
queue_id long 22 No

Unique identifier associated with a specific queued plan change
plan_instance_no long 22 No

The subscription plan instance number.

Alternative field: client_plan_instance_id
client_plan_instance_id string 100 No

Client-defined plan Subscription plan instance ID.

Alternative field: plan_instance_no
queued_action_status_cd long 1 No

Filters the list of queued plan changes returned based on the status code

Allowed values:

Value Description
0 Deleted
1 Queued
2 Executed successfully
3 Failed to execute
4 All (default if no value is provided)

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.
queued_change_details object   No

See fields below

queued_change_details.queued_plan_custom_rates fields

Name Type Length Required Description
custom_rate_service_no long 22 No

The service number for the new custom rate
custom_rate_client_service_id string 32 No

The client-defined service ID for the new custom rate.
custom_rate_seq_no long 22 No

The sequence number for this line of the rate schedule
custom_rate_from_unit double 22 No

Tiered pricing, "FROM" unit
custom_rate_to_unit double 22 No

Tiered pricing, "TO" unit
custom_rate_per_unit double 22 No

The rate to charge per unit on this tier

queued_change_details fields

Name Type Length Required Description
queue_id long   No

Unique identifier associated with a specific queued plan change
plan_instance_no long   No

The unique identifier of the plan instance
client_plan_instance_id string   No

The client-defined identifier of the plan instance
parent_plan_instance_no long 22 No

The unique identifier of the parent plan instance.
client_parent_plan_instance_id string 100 No

The client-defined identifier of the parent plan instance.
queued_action_status_cd long   No

The current status code associated with a queued plan change

Allowed values:

Value Description
0 Deleted
1 Queued
2 Executed successfully
3 Failed to execute
queued_action_status_label string   No

The current status associated with a queued plan change

Allowed values:

Value Description
0 Deleted
1 Queued
2 Executed successfully
3 Failed to execute
current_plan_no long   No

Unique identifier of the plan currently associated with the plan instance
current_client_plan_id string   No

Client-defined identifier of the plan currently associated with the plan instance
current_plan_name string   No

Name of the plan currently associated with the plan instance
current_plan_units long   No

Number of plan units currently associated with the plan instance.
current_plan_inst_status long   No

Note: This field is deprecated. Aria no longer supports current_plan_inst_status.
current_rate_schedule_no long   No

Unique identifier of the rate schedule currently associated with the plan instance.
current_client_rate_schedule_id string   No

Client-defined identifier of the rate schedule currently associated with the plan instance
effective_date string 10 No

Date on which the queued plan change will take effect
target_plan_no long   No

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   No

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   No

Name of the plan that will be associated with the plan instance after the queued plan change takes effect
target_plan_units long   No

Number of plan units that will be associated with the plan instance after the queued plan change takes effect
target_plan_inst_status long   No

Note: This field is deprecated. Aria no longer supports target_plan_inst_status.
target_rate_schedule_no long   No

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   No

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   No

User ID that created the queued plan change.
queuing_date string   No

Date on which the queued plan change was created
deleting_user_id string   No

User ID that deleted the queued plan change
deleting_date string   No

Date on which the queued plan change was deleted
execute_immediately_user_id string   No

User ID that immediately executed the queued plan change
execute_immediately_date string   No

Date on which the queued plan change was immediately executed
editing_user_id string   No

User ID that most recently edited the queued plan change
editing_date string   No

Date on which the queued plan change was most recently edited
current_plan_inst_status_2 long   No

Status currently associated with the plan instance.

Allowed values:

Value 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
target_plan_inst_status_2 long   No

Status of the plan instance after the queued plan change takes effect.
queued_plan_custom_rates object   No

An array of custom rates for the specified account number

See fields below
current_rate_schedule_name string   No

Name of of the rate schedule currently associated with the plan instance.
target_rate_schedule_name string   No

Name of the rate schedule that will be associated with the plan instance after the queued plan change takes effect.
anniversary_queue_ind long   No

Indicator for anniversary type queue.
processed_by_batch_ind long   No

To indicate if the queue was executed via batch process.
queue_type long   No

Indicates the queue action.

Allowed values:

Value Description
1 Plan Assignment
2 Mandatory Child Plan Assignment
3 Plan Replacement
4 Plan Rollover
5 Plan Cancellation
6 Plan Update (units, rate schedule, status, etc)
7 Plan Status Change
execute_allowed long   No

To indicate if the immediate execution is allowed for the queue.
change_effective_date_allowed long   No

To indicate if effective date change is allowed for the queue.
delete_allowed long   No

To indicate if queue can be deleted.
update_date string   No

The date when queue was last modified.
TOP
  1. Back to top
  • Was this article helpful?

Recommended articles

  1. Page type
    Topic
  2. Tags
    This page has no tags.