Skip to main content
Aria Knowledge Central

modify_instance_contract_m Sample Call and Response

This example shows an additional plan instance being added to an existing multi-plan instance contract on an account, based on the modify_instance_contract_m method defined in plsql_m_r73.yml.

This example includes every required field and a representative set of optional fields for adding one plan instance to a contract and setting the contract to renew automatically at its end date. It does not cover removing a plan instance from a contract, configuring a rollover plan or rollover custom rates, or overriding the contract's renewal duration.

Sample call

{
  "rest_call": "modify_instance_contract_m",
  "output_format": "json",
  "client_no": 32409,
  "auth_key": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6",
  "acct_no": 5008842,
  "contract_no": 771310,
  "type_no": 3,
  "modify_directive": 1,
  "contract_plan_instances_update": [
    {
      "plan_instance_no": 881204
    }
  ],
  "start_date": "2026-08-01",
  "end_date": "2027-07-31",
  "cascade_action": "true",
  "update_comments": "Adding the premium support plan instance to the existing multi-plan contract at the customer's request."
}

The field acct_no identifies the account rather than its alternative, client_acct_id, and contract_no identifies the contract rather than its alternative, client_contract_id, since both are the Aria-assigned numeric identifiers. The field modify_directive is set to 1, meaning this call adds a plan instance to the contract; other valid values are 2 (remove a plan instance), 3 (add a rollover plan for the plan instance), 4 (remove the rollover plan for the plan instance), and 5 (modify the rollover plan for the plan instance). The field contract_plan_instances_update is a JSON array because the method description explains that this method modifies a contract for one or more plan instances; this example shows one entry, identifying the plan instance being added by its Aria-assigned plan_instance_no rather than the alternative client_plan_instance_id. The field type_no is set to 3, meaning the contract renews automatically at the end of its term; other valid values are 2 (continue existing service without a contract, the default), 6 (terminate service and billing), 7 (terminate service and billing and prorate the final invoice), 8 (roll over to a different plan, rate, or custom rates, for multi-plan contracts only), and 9 (renew automatically with a different duration). This example supplies end_date directly rather than its alternative, duration_length, to set the current contract term's end date. The field cascade_action is set to the string value "true", indicating the cascade option was selected when this plan instance was assigned to the contract; the other valid value is "false". The fields rest_call and output_format are envelope fields added by the REST layer and are not part of the method's own documented arguments.

This example leaves out new_client_contract_id, which would assign a new client-defined identifier to the contract; cancel_fee, which would set a fee charged if the last remaining plan instance on the contract is cancelled before the contract's end date; contract_rollover_custom_rates, which would define custom rate schedule lines to use as the rollover rate at the completion of the contract; duration_type, duration_length, renewal_duration_type, renewal_duration_length, and renewal_end_date, which are alternate ways of expressing contract and renewal duration rather than explicit dates; and do_auto_discard, which controls whether existing contracts covering the same plans are automatically discarded. It also omits length_months, since that field is deprecated as of update version 60 in favor of duration_type and duration_length.

Sample response

{
  "error_code": 0,
  "error_msg": "OK"
}

The error_code value of 0 and the error_msg value of "OK" indicate that the contract modification completed without error. This example leaves out the error_details field entirely, since that field is marked nonpublic in the yml and is not populated in responses to client callers.

TOP
  • Was this article helpful?