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

 

Home > Aria Crescendo core api > update_acct_plan_status_m

update_acct_plan_status_m

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.

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.
plan_instance_no long 22 The unique identifier of the plan instance (can be either a master or supplemental plan).
  OR      
  client_plan_instance_id string 100 The client-defined identifier of the plan instance (can be either a master or supplemental plan).
status_cd long   The status of this plan instance   Allowable Values
  OR      
  dunning_state long 100 Dunning state assigned to the master plan instance. In Progress indicates the master plan is in dunning. None indicates the master plan is not in dunning. Note that dunning state is applicable only for master plans and is set to Complete by the system once the dunning process is completed.   Allowable Values
  OR      
  degrade_date string 100 Date on which the Dunning Manager evaluates whether the master plan should be advanced to the next step of the dunning process. Applicable only for master plans, and only if the dunning_state is set to 1.
  queue_days long 12 Days in to queue before the status change occurs.
  queue_date string   Specific date for the status change to occur
  force_bill_date_reset long 1 Determines whether to reset the billing dates to either the status change date or current anniversary date, reset the billing dates when the status changes from non-provisionable to provisionable depending on client parameter 'RESET_DATES_ON_REPROVISIONED_STATUS' setting, or not reset at all.   Allowable Values
  comments string 500 Additional explanatory text relating to this API call.
  client_receipt_id string 50 Client-defined unique identifier used to track related system actions
  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.
  application_id string 300 The application identifier in which the API is being used in. (Example: “Sales Force”)
  application_date string 300 The application date/timestamp, ie. 01/01/2014 10:00:00 to track when the application called the API.

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.

You must to post a comment.
Last modified
14:39, 2 Feb 2017

Tags

This page has no custom tags.

Classifications

This page has no classifications.