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

The filter_status_code is the Aria code used to filter account contract for Inactive or Active (0 or 1). Value of "null" returns account contracts without filtering by status, and is the default.

This indicator determines if terminated plan instances should be excluded from the return. If True is passed, the API shall exclude (not return) any plan instances that have a status of Terminated.

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

Alternative field: locale_name

Name of the locale.

Alternative field: locale_no

Limits the number of records returned in the all_acct_contracts_m array. Min of 1 and Max 999. If no value is specified all possible records will be returned.

The number of records to skip in the all_acct_contracts_m array. Min of 0 with no maximum value. If no value specified the default is 0.

Unique plan instance number for each assigned plan instance.

Unique client-defined ID for each assigned plan instance.

This parameter is ignored when 'Enable Contract Billing Installment' client parameter is set to false and the API won't return contract billing values. If the client parameter is set to true and this parameter is set to 1, the API will return contract billing values(invoiced_contract_period, invoiced_billing_cycle, remaining_contract_period, and remaining_billing_cycle) in contract_plan_instance_info.

Aria-assigned error identifier. 0 indicates no error.

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

See fields below

Name of the account level locale.

Aria-assigned unique identifier of the locale used for translations. This value is unique across all Aria-managed accounts.

Returns a total count of the number of contracts.

Returns a count of the number of contracts based on the filtered status code selection.

Plan instance for which the custom rates will be used at the completion of the contract.

Client-defined ID of the plan instance for which the custom rates will be used at the completion of the contract.

Service number for the new custom rate

Unique client-defined identifier for the custom rate service number.

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.

The unique numberic identifier of the plan instance..

The name of the plan this line represents

Unique client-defined ID for each assigned master plan.

The status code of the plan instance associated with this account.

This is the status for each plan instance associated with the contract. (ex: Active, Terminated etc.).

The number of full months of the contract period that have already been billed. If last month is not a whole month, it is considered as one month.

The number of full billing cycles that have been invoiced and that cover a portion or the whole period of the contract.

The remaining number of full months of the contract yet to be billed. If last month is not a whole month, it is considerd as one month.

A projected number of full billing cycles to be billed that would cover the remaining period of the contract.

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.

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.

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

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

See fields below

Aria-assigned unique contract identifier.

Client assigned unique contract identifier

Specifies the scope of plan subscription coverage enforced by the contract.

The type of contract end action to be enforced by this 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.

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

Comments provided at time of last contract update.

The date the contract was created.

The date the contract was last modified.

Specifies contract start date. The date is in the format yyyy-mm-dd.

Contract end date.

Status code of this contract.

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.

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.

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.