Skip to main content
Knowledge Central
Aria Knowledge Central

create_instance_contract_m

  1. Last updated
  2. 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.

For information on error messages generated by this API, see create_instance_contract_m Error Messages.

Input Arguments

 
Req Field Name Field Type Max Length Description
required-icon.png client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
required-icon.png auth_key string 32 Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.
required-icon.png acct_no long 22 Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
  OR      
  client_acct_id string 50 Client-defined account identifier.
required-icon.png type_no long 8

The type of contract end action to be enforced by this contract.

Allowable values for type_no:

 
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)
required-icon.png length_months long 8 Number of months, starting from start_date, that the given contract will be in effect.
  OR      
  end_date string 10 End date of the date range covered by this line item in yyyy-mm-dd format.
Start of contract_plan_instances array
required-icon.png contract_plan_instances array    
  Field Name Field Type Max Length Description
required-icon.png plan_instance_no long 22 The Master Subscription plan instance number.
  OR      
  client_plan_instance_id string 100 Unique client-defined identifier for the master plan instance.
  rollover_plan_no long 22 Note that if the target rollover plan has a surcharge that has already been associated with this account, when the plan rollover occurs at the completion of this contract, the surcharge for this plan may be ignored (depending on the client parameter determining whether duplicate surcharges are permitted). The surcharge at the account level will remain in effect.
  OR      
  rollover_client_plan_id string 100 Note that if the target rollover plan has a surcharge that has already been associated with this account, when the plan rollover occurs at the completion of this contract, the surcharge for this plan may be ignored (depending on the client parameter determining whether duplicate surcharges are permitted). The surcharge at the account level will remain in effect.
  rollover_rate_sched_no long 22

Pre-defined rate schedule to be used as the rollover rate schedule at the completion of the contract.

Note that 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.
  OR      
  rollover_client_rate_sched_id string 100 Client-defined ID of the pre-defined rate schedule to be used as the rollover rate schedule at the completion of the contract.
End of contract_plan_instances array
 
  client_contract_id string 100 Client assigned unique contract identifier..
  cancel_fee double 12 Fee to be charged if the plan instance is canceled by the account holder. For a multi-plan contract, this will be applicable only when the last remaining plan instance is canceled prior to the contract's end date.
  create_comments string 300 CSR or API-provided comments provided at time of contract creation.
  start_date string 10 Contract start date in yyyy-mm-dd format. Defaults to the current date if not specified. This field is required for a plan or contract with a future start date.
  do_auto_discard string 5

Whether, upon creation of this contract, the system automatically discards any existing contracts in effect that cover the same plan or set of plans.

Allowable values for do_auto_discard:

 
Values Description
true true
false false
  cascade_action string 5

An indicator on the plan_instance associated to the contract should indicate if the cascade option was selected when the plan_instance was assigned to the contract.

Allowable values for cascade_action:

 
Values Description
true true
false false
Start of contract_rollover_custom_rates array
  contract_rollover_custom_rates array    
  Field Name Field Type Max Length Description
  custom_rate_plan_instance_no long 22 Plan instance for the new custom rate schedule to be used as rollover custom rate at the completion of the contract.
  OR      
  custom_rate_client_plan_instance_id string 100 Unique client-defined identifier for the master plan instance.
  custom_rate_service_no long 22 Service number for the new custom rate
  OR      
  custom_rate_client_service_id string 100 The client-defined service ID for the new custom rate.
  custom_rate_seq_no long 22 Sequence number for this line of the rate schedule
  custom_rate_from_unit long 22 Tiered pricing, "FROM" unit
  custom_rate_to_unit long 22 Tiered pricing, "TO" unit
  custom_rate_per_unit double 12 Rate to charge per unit on this tier
End of contract_rollover_custom_rates array
 
  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.
Start of optional_transaction_qualifiers array
  optional_transaction_qualifiers array   Array of additional values you can associate with this API call.
  Field Name Field Type Max Length Description
  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.
End of optional_transaction_qualifiers array
 

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.
contract_no long Aria-assigned unique contract identifier
  1. Back to top
  • Was this article helpful?

Recommended articles

  1. Page type
    Topic
  2. Tags
    This page has no tags.