Skip to main content
Aria Knowledge Central

update_acct_plan_status_m Guide

Sets the status of a master or supplemental plan for a given account and optionally indicates the number of days or date in the future on which the status change should go into effect. This call can also reset the billing dates on the status change date for master plans changing from a non-billable to a billable status.

API Specification: update_acct_plan_status_m
Required Fields:
  • <client_no>
  • <auth_key>
  • <acct_no> or <client_acct_id>
  • <plan_instance_no> or <client_plan_instance_id>

Error Codes

Error Code/Description Associated Inputs
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Additional Guidance

Input Fields
Field Name: Notes:
<status_cd>

If you are updating a Master Plan Instance, you must enter a value either in this field or in the <dunning_state> field.

If you are updating a Supplemental Plan, this field is required.

If you previously queued (scheduled) custom rates to be applied to the Master Plan Instance and you do not set the status code to "active" (1), then the custom rates will not be applied when you call this API. However, the scheduled custom rates will remain queued on the Master Plan Instance and they will be applied when the account is switched to the provisioned (active) status in the future.

Allowable Values
Values Description
0 INACTIVE
1 ACTIVE
2 CANCELLATION PENDING
3 TERMINATION PENDING
31 INSTALLATION PENDING
32 REGISTERED PENDING ACTIVATION
41 ACTIVE TRIAL
61 ACTIVE NON-BILLABLE
-1 SUSPENDED
-2 CANCELLED
-3 TERMINATED
<dunning_state>

If you set this field to "1" (in progress), then you can specify one or more of the following dunning options available in these fields:

  • <degrade_date>;
  • <new_dunning_step>;
  • <config_dunning_late_fee_option>; and/or
  • <config_dunning_email_option>.

When you change the <dunning_state> to "0" (none), you should also pass in your chosen <status_cd> for the Master Plan Instance.

Example: you may want to change the Master Plan Instance's status from -1 (suspended) to 1 (active).

If you set this field to 1 (in progress) but the Master Plan Instance does not have a balance due, then Aria will move the Master Plan Instance out of dunning on the date on which the next dunning step begins.This applies to Master Plan Instances associated with either payment type: net terms or electronic.

In addition to self-pay Master Plan Instances, dunning input arguments can now also now be used for parent-pay Master Plan Instances. Also note that when self-pay Master Plan Instance manually enters dunning via this API, all of their parent-pay Master Plan Instances will enter dunning. This is only applicable when entering the dunning. During this special process of entering parent-pay Master Plan Instance, the “config_dunning_late_fee_option and config_dunning_email_option” will only be applicable for self-pay Master Plan Instances and NOT to the parent-pay Master Plan Instance.

Allowable Values
Values Description
0 None
1 In Progress
<config_dunning_late_fee_option>

Applicable only for Master Plans, and only if the <dunning_state> is set to "1".

For more information about available dunning options, please see the <dunning state> field.

If you set this field to "1", Aria will immediately charge the customer the late fee.

<config_dunning_email_option>

Applicable only for Master Plans, and only if the <dunning_state> is set to "1".

For more information about available dunning options, please see the <dunning state> field.

If you set this field to "1", Aria will immediately email the notification to the customer.

<force_bill_date_reset>
Allowable Values
Values Description
NULL Reset the billing dates when the status changes from non-billable to billable depending on client parameter 'AUTO_RESET_MASTER_PLAN_BILLING_DATES_ON_NON_BILLABLE_TO_BILLABLE_MASTER_PLAN_STATUS_CHANGE' setting.
0 Do not reset the billing dates for this Plan.
1 Reset the billing anniversary date to coincide with the status change date.
2 Reset the billing anniversary date to coincide with the current anniversary date.
<config_dunning_late_fee_option>
Allowable Values
Values Description
1 Use dunning process configuration settings (default).
0 Do not use dunning process configuration/do not charge late fee.
<config_dunning_email_option>
Allowable Values
Values Description
1 Use dunning process configuration settings (default).
0 Do not use dunning process configuration/do not send email notification.
  • Was this article helpful?