Aria-assigned unique identifier indicating the Aria client providing service to this account.

Aria-assigned unique key for authenticating the validity of the requestor. This key is passed with each method call.

Aria-assigned account identifier. This value is unique across all Aria-managed accounts.

Alternative required field: client_acct_id

Client-defined account identifier.

Alternative required field: acct_no

Aria-assigned unique contract identifier.

Alternative required field: client_contract_id

Client assigned unique contract identifier..

Alternative required field: contract_no

Client assigned unique contract identifier..

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

CSR or API-provided comments provided at time of modify contract.

Fee to be charged if the plan instance is cancelled by the account holder. For a multi-plan contract, this will be applicable only when the last remaining plan instance is cancelled prior to the contract's end date.

Whether to add or remove the contract

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.

End date of the date range covered by this line item in yyyy-mm-dd format.

Alternative field: duration_length

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.

See fields below

See fields below

Indicator which determines whether the contract duration in length is based on months, weeks or days.

The contract duration in length that the given contract will be in effect from the start date.

Alternative field: end_date

Indicator which determines whether the contract renewal duration in length is based on months, weeks or days.

The contract renewal duration in length that the given contract will be in effect from the renewal start date.

Alternative field: renewal_end_date

Date on which the renewal contract ends. Date format is YYYY-MM-DD. For the new contract type '9-Renew contract with different duration', it is mandatory to pass the either the renewal_end_date or the renewal_duration_type and renewal_duration_length. If both are passed, renewal_duration_length will take the precedence over the renewal_end_date.

Alternative field: renewal_duration_length

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

The Aria-assigned unique identifier of the master plan instance or supplemental plan instance to be added to or removed from the contract (per the modify_directive input parameter).

Alternative field: client_plan_instance_id

The client-defined identifier of the master plan instance or supplemental plan instance to be added to or removed from the contract (per the modify_directive input parameter).

Alternative field: plan_instance_no

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.

Alternative field: rollover_client_plan_id

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.

Alternative field: rollover_plan_no

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

Alternative field: rollover_client_rate_sched_id

Client-defined ID of the pre-defined rate schedule to be used as the rollover rate schedule at the completion of the contract.

Alternative field: rollover_rate_sched_no

Plan instance for the new custom rate schedule to be used as rollover custom rate at the completion of the contract.

Alternative field: custom_rate_client_plan_instance_id

Unique client-defined identifier for the master plan instance.

Alternative field: custom_rate_plan_instance_no

Service number for the new custom rate

Alternative field: custom_rate_client_service_id

The client-defined service ID for the new custom rate.

Alternative field: custom_rate_service_no

Sequence number for this line of the rate schedule

Tiered pricing, "FROM" unit

Tiered pricing, "TO" unit

Rate to charge per unit on this tier

Aria-assigned error identifier. 0 indicates no error.

Description of any error that occurred. "OK" if there was no error.