Skip to main content
Aria Knowledge Central

modify_instance_contract_m Guide

It modifies an existing multi plan instance contract for a specified account holder and one or more plan instances.

API Specification: modify_instance_contract_m
Required Fields:
  • <client_no>
  • <auth_key>
  • <acct_no> or <client_acct_id>
  • <contract_no> or <client_contract_id>

Error Codes

Error Code/Description Associated Inputs

1001: unexpected error


1004: authentication error

Associated Inputs: auth_key, client_id, client_no

<client_no>, <auth_key>

1009: account does not exist, Account not found: AriaNo (acct_no), Account not found: Userid (userid), or Account not found: ClientId (client_acct_id)

Associated Inputs: acct_no, account_no, client_acct_id, user_id, userid, parent_acct_no

<acct_no>, <client_acct_id>

1010: missing required parameters, Missing input: (object-name) is required with assignment_directive ($AriaNo)

Associated Inputs: all required inputs, typically one of the following: custom_rate_per_unit, custom_rate_seq_no, status_cd, dunning_state, userid, acct_no, client_acct_id, assignment_directive, billing_group_no, client_billing_group_id, threshold_billing_rule_no, client_threshold_billing_rule_id

Alternate Message Output

1010: username is required
1010: first name is required
1010: last name is required
1010: email is required
1010: roles are required

Associated APIs: create_user_m, get_user_details_m, delete_user_m, update_user_m

Associated Inputs: username, first_name, last_name, email, role_no

<client_no>, <auth_key>, <acct_no> or <client_acct_id>, <contract_no> or <client_contract_id>

1016: invalid input, acct_no: (acct_no) is not a valid long, assignment_directive: (assignment_directive) is not a valid long, “billing_group_no: (billing_group_no) is not a valid long, threshold_billing_rule_no: (threshold_billing_rule_no) is not a valid long

Associated Inputs: alt_service_no_to_apply, assignment_directive, auto_skip_to_next_bill_date, client_billing_group_id, custom_rate_service_no/custom_rate_client_service_id, plan_instance_no, plan_instance_service_no, client_plan_instance_id, client_plan_instance_service_id, plan_instance_no, plan_instance_service_no, client_plan_instance_id, client_plan_instance_service_id, plan_instance_service_no, eligible_plan_no, eligible_service_no, email, force_master_bill_date_reset, fulfillment_only, include_master_plans, include_supp_plans, include_billing_groups, include_payment_methods, include_master_plans, include_supp_plans, include_billing_groups, include_payment_methods, invoice_no, length_months, end_date, limit, limit_records, modify_directive, contract_plan_instances_update, modify_directive, contract_plan_instances_update, offset, percent_amount, percent_eval_plan_instance_no, client_percent_eval_plan_instance_id, percent_eval_service_no, client_percent_eval_service_id, phone_ext, work_phone_ext, plan_unit_inst_status_cd, plan_units, reason_code, start_date, end_date, start_date, end_date, status_cd, acct_no, assignment_directive, billing_group_no, threshold_billing_rule_no

Additional Comments:  This error can be caused by the wrong type of input, for example, text in a numbers-only field, an  or specifying a value other than one of the documented allowable values.

  • For the get_order_m API, this is the error code returned when the user passes an invalid order value for the <status_filter_cd> input which is other than the allowed values (0/null, 1, 2, 3, 4 and 5).
  • For the bulk_cancel_order_m API, invalid input can occur with the <order_status_directive> argument. Allowed values are 0, 1, 2, 3, 4/null, 5 and 6.
  • For the get_acct_coupon_details_m API, invalid input can occur with the <include_all_active> input parameter (values are 0, 1 or NULL).

Alternate Message Output

1016: username cannot be longer than 30 characters
1016: first_name cannot be longer than 30 characters
1016: last_name cannot be longer than 30 characters

Associated APIs: create_user_m, update_user_m

Associated Inputs: username, first_name, last_name

<client_no>, <acct_no>, <contract_no>, <type_no>, <length_months>, <cancel_fee>, <modify_directive>, <plan_instance_no>, <rollover_plan_no>, <rollover_rate_sched_no>, <custom_rate_plan_instance_no>, <custom_rate_service_no>, <custom_rate_seq_no>, <custom_rate_from_unit>, <custom_rate_to_unit>, <custom_rate_per_unit> 

1033:  a parameter that represents a true or false value contains invalid input

Associated Inputs: alt_collect_on_approve, alt_send_statement_on_approve, cancel_orders_on_discard, cascade_action, do_auto_discard, do_collect, change_status_after_coll, reset_dates_after_status, disable_existing_on_update, do_write, exclude_terminated_plan_inst, include_all_rate_schedules, include_plan_hierarchy, retrieve_bundled_nso, retrieve_included_nso, include_translations, include_inactive_items, include_invoice_activity_eligibility, include_rs_summary, include_translations, include_service_supp_fields/include_product_fields/, include_plan_instance_fields/include_plan_services/, include_surcharges, include_void_transactions, include_voided, invoice_unbilled_usage, is_unlinked_refund, record_cc_on_auth_failure, retrieve_excluded_usage, send_email, usage_pooling, do_write


14005: invalid Plan service combination

Associated Inputs: custom_rate_service_no, custom_rate_service_id

Additional Comments: The given Plan number and service number combination for master and Supplemental Plans is not valid.

<custom_rate_service_no>, <custom_rate_client_service_id>

14014: When entering custom rates, the end sequence number of one tier must immediately precede the start sequence number of the next tier. Alt: invalid rate tier structure

Associate Inputs: custom_rate_to_unit, custom_rate_seq_no

Additional Comments:

When entering custom rates, the tiers must be continuous, that is, the end sequence number of one tier must immediately precede the start sequence number of the next tier. In addition, the rate schedule must have the same number of units in each tier, and the same number of tiers, as the schedule on which it is based. From_units must be greater than - and less than to_units.

<custom_rate_to_unit>, <custom_rate_seq_no>

14015: The custom rates for services other than usage and recurring types can have only one tier with rate_seq_no set to 1, the from_unit set to 1 and to_unit left empty. Alt: custom from and to units not supported for given service_no

Associated Inputs: custom_rate_from_unit, custom_rate_to_unit

Additional Comments: For the custom rate sequence, the "from" unit in one tier is not immediately after the end unit in the previous tier. Tiers are not allowed for other than recurring and usage services.

<custom_rate_from_unit>, <custom_rate_to_unit>

14027: The end units of final rate tier is not infinity

Associated Inputs: custom_rate_to_unit

Additional Comments: The custom rates final unit must be infinity.


14035: Invalid client Plan id

Associated Inputs: client_plan_id, custom_rate_client_plan_instance_id

<client_plan_instance_id>, <custom_rate_client_plan_instance_id>

14036: Invalid client service id

Associated Inputs: client_service_id, client_plan_instance_service_id, client_percent_eval_service_id, custom_rate_client_service_id


14039: Invalid client rate schedule id

Associated Inputs: client_alt_rate_schedule_id, rollover_client_rate_sched_id


14043: Invalid Plan instance rate_seq combination

Associated Inputs: custom_rate_from_unit, custom_rate_to_unit

Additional Comments: If the from/to units are not specified, the given rate_seq_no must be a valid rate_seq_no.

<custom_rate_from_unit>, <custom_rate_to_unit>

14046: If you passed in an invalid plan_instance_no, this message will appear: "Invalid Plan instance number". If you passed in an invalid master_plan_instance_id, this message will appear: "Invalid master_plan_instance_id".

Associated Inputs: plan_instance_no, master_plan_instance_id, filter_plan_instance_no, percent_eval_plan_instance_no, client_plan_instance_id

Additional Comments: The plan_instance_no or master_plan_instance_id must belong to the account, or it is invalid. The percent_eval_plan_instance_no must belong to the account and also to the MPI given in input.

<plan_instance_no>, <client_plan_instance_id>, <custom_rate_plan_instance_no>, <custom_rate_client_plan_instance_id>

14047: If you passed in an invalid client_plan_instance_id, this message will appear: "Invalid client Plan instance identifier". If you passed in an invalid client_master_plan_instance_id , this message will appear: "Invalid client_master_plan_instance_id".

Associated Inputs: client_plan_instance_id, client_master_plan_instance_id, client_percent_eval_plan_instance_id

<client_plan_instance_id>, <custom_rate_client_plan_instance_id>

14082: Plan instance specified for contract completion rate schedule rollover is not included in the contract definition

Associated Inputs: custom_rate_plan_instance_no, custom_rate-client_plan_instance_id

<custom_rate_plan_instance_no>, <custom_rate_client_plan_instance_id>

14089: Mandatory child Plans have not been added as part of the contract.

Associated Inputs: cascade_action, modify_directive, contract_plan_instances_update

Additional Commetns: This error occurs when cascade_action is false and modify_directive is add.

<cascade_action>, <modify_directive>, <contract_plan_instances_update>

14105: Mandatory child Plans should be removed from the contract along with the parent Plan.

Associated Inputs: cascade_action, modify_directive, contract_plan_instances_update

Additional Comments: This eror occurs when cascade_action is false and modify_directive is remove.

<cascade_action>, <modify_directive>, <contract_plan_instances_update>

14106:This mandatory child Plan cannot be removed from the contract without its parent Plan and other mandatory child Plans.

Associated Inputs: cascade_action, modify_directive, contract_plan_instances_update

<cascade_action>, <modify_directive>, <contract_plan_instances_update>

14107: Invalid Service Number.

Associated Input: custom_rate_service_no


16001: contract does not exist

Associated Inputs: contract_no, client_contract_id

<contract_no>, <client_contract_id>

16005: Invalid Modify_Directive.

Associated Input: modify_directive


16006: This contract is ineligible for editing because its scheduled end date is in the past.


16007: This contract is ineligible for editing because it is no longer in effect.

Associated Inputs: contract_no, client_contract_id

<contract_no>, <client_contract_id>

16012: Contract end date is less than start date

Associated Inputs: date_range_start, date_range_end, start_date, end_date, length_months


16013: Unsupported contract type

Associated Inputs: contract_type_no, type_no


16015: Plan Instance is not in this contract. No Plan instances were removed

Associated Inputs: Plan_instance_no, client_plan_instance_id

<plan_instance_no>, <client_plan_instance_id>

16016: The Plan instance can not be added because it is already in the contract.

Associated Inputs: plan_instance_no, client_plan_instance_id

<plan_instance_no>, <client_plan_instance_id>

16017: At least one Plan instance must be in this contract.  Cannot remove all Plan instances

Associated Inputs: modify_directive, contract_plan_instances_update


16019: Multi Plan instance contract cannot be created because the given Plan instance statuses on this account are Suspended, Pending Cancellation, Cancelled or Terminated.

Associated Inputs: plan_instance_no, client_plan_instance_id

<plan_instance_no>, <client_plan_instance_id>

16020: The target Plan used for contract rollovers must be a sibling of the existing Plan in the product catalog.

Associated Inputs: rollover_plan_no, client_rollover_plan_id

<rollover_plan_no>, <rollover_client_plan_id>

16021: The currency for the contract completion rollover target rate schedule must match the currency on the account.

Associated Inputs: rollover_rate_sched_no/rollover_client_rate_sched_id

<rollover_rate_sched_no>, <rollover_client_rate_sched_id>

16022: The contract rollover target rate schedule is not associated with the contract completion rollover target Plan.

Associated Inputs: rollover_rate_sched_no, rollover_client_rate_sched_id

<rollover_rate_sched_no>, <rollover_client_rate_sched_id>

16023: The contract completion target rate schedule rollover is not associated with the Plan instance specified.

Associated Inputs: rollover_rate_sched_no, rollover_client_rate_sched_id

<rollover_rate_sched_no>, <rollover_client_rate_sched_id>

16024: The contract rollover target Plan no is ineligible because it must be Master Plan no

Associated Inputs: rollover_plan_no, rollover_client_plan_id

Additional Comments: The current and rollover Plan types must match.

<rollover_plan_no>, <rollover_client_plan_id>

16025: The contract rollover target Plan no is ineligible because it must be Supplemental Plan

Associated Inputs: rollover_plan_no, rollover_client_plan_id

<rollover_plan_no>, <rollover_client_plan_id>

16030: The contract start date must be on or after the earliest effective date (plan assignment date or retroactive start date) of the Plans covered by the contract.

Associated Inputs: contract_start_date, start_date


16031: duplicate client contract id.

Associated Input: client_contract_id, new client_contract_id

<client_contract_id>, <new_client_contract_id>

16033: The contract end date cannot be today or earlier (whether provided as input or calculated based on the contract term and start date).


25020: Illegal characters entered

Associated Inputs: All character field inputs like firstname lastname, dunning_group_name, comments, etc.

<auth_key>, <client_acct_id>, <client_contract_id>, <new_client_contract_id>, <update_comments>, <start_date>, <end_date>, <cascade_action>, <client_plan_instance_id>, <rollover_client_plan_id>, <rollover_client_rate_sched_id
custom_rate_client_plan_instance_id>, <custom_rate_client_service_id>, <alt_caller_id>, <attach_qualifier_option>, <qualifier_name>, <qualifier_value>

Additional Guidance

Input Fields
Field Name Notes
Allowable Values
Values Description
2 Continue existing service without contract (default)
3 Renew existing contract automatically
6 Terminate service and billing
7 Terminate service and billing and prorate final invoice
8 Rollover to a different plan/rate/custom rates (applicable only for multi-plan contracts).
Allowable Values
Values Description
1 Add plan instance
2 Remove plan instance
3 Add rollover plan for the plan instance
4 Remove the rollover plan for the plan instance
5 Modify the rollover plan for the plan instance
Allowable Values
Values Description
true true
false false
  • Was this article helpful?