create_instance_contract_m Guide

Last updated
Save as PDF

Creates a multi-plan contract for a specified account holder and specified list of plans. The plans can be master plans or supplemental plans.

API Specification:	create_instance_contract_m
Required Fields:	<client_no> <auth_key> <acct_no> or <client_acct_id> <type_no> <length_months> or <end_date> <contract_plan_instances> (array) <plan_instance_no>
Error Messages:	create_instance_contract_m Error Messages

Additional Guidance:

Input Fields

Field Name:

Notes:

<rollover_rate_sched_no>

If you have added a custom rate to a standard price for a rate schedule rollover with a multi-Plan contract during a batch execution, the system will remove existing custom rates at the time the batch is executed.

If you wish to go back to standard rates from custom rates for the existing rate schedule via contract, then when creating a contract with create_instance_contract_m, pass "rollover_rate_sched_no" input argument without the "rollover_plan_no" input.

<type_no>

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)

<do_auto_discard>

Allowable values

Values	Description
true	true
false	false

<cascade_action>

Allowable values

Values	Description
true	true
false	false