create_acct_universal_contract_m
Summary
| API Name | create_acct_universal_contract_m |
|---|---|
| Class | account_services_m |
| Update Version | 60 |
Description
Creates a universal contract on an account. A universal contract in Aria is a commitment agreement that applies across ALL plan instances on the account — it defines a minimum contract term, early termination fees, and other contractual obligations that the customer agrees to regardless of which specific plans they are subscribed to. If a customer cancels or downgrades before the contract end date, early termination fees may apply.Universal contracts differ from instance contracts (created via create_instance_contract_m), which apply only to specific plan instances. Use universal contracts for broad account-level commitments (e.g., "12-month minimum term") and instance contracts for plan-specific terms. To cancel a universal contract, use cancel_acct_universal_contract_m. To view existing contracts, use get_acct_universal_contract_m or get_all_acct_contracts_m.
Inputs
| Name | Type | Length | Required | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| client_no | long | 22 | Yes |
Aria-assigned unique identifier indicating the Aria client providing service to this account. |
||||||||||||
| auth_key | string | 32 | Yes |
Aria-assigned unique key for authenticating the validity of the requestor. This key is passed with each method call. |
||||||||||||
| acct_no | long | 22 | Yes |
Aria-assigned account identifier. This value is unique across all Aria-managed accounts. Alternative required field: client_acct_id |
||||||||||||
| client_contract_id | string | 100 | No |
Client assigned unique contract identifier |
||||||||||||
| type_no | long | 2 | No |
Type of contract "end action" to be enforced by this contract. Allowed values:
|
||||||||||||
| length_months | long | 4 | Yes |
Note: This field is deprecated. Aria no longer supports length_months. |
||||||||||||
| create_comments | string | 300 | No |
Comments entered by CSR, or included in API input, when contract was created. |
||||||||||||
| start_date | string | 10 | No |
Contract start date in the format yyyy-mm-dd. Defaults to the current date if left blank. |
||||||||||||
| end_date | string | 10 | Yes |
End date of the contract in yyyy-mm-dd format. Alternative required field: duration_length or length_months |
||||||||||||
| client_acct_id | string | 50 | Yes |
Client-defined account identifier. Alternative required field: acct_no |
||||||||||||
| duration_type | long | 1 | No |
Indicator which determines whether the contract duration in length is based on months, weeks or days. Allowed values:
|
||||||||||||
| duration_length | long | Yes |
The contract duration in length that the given contract will be in effect from the start date. Alternative required field: end_date or length_months |
|||||||||||||
| renewal_duration_type | long | 1 | No |
Indicator which determines whether the contract renewal duration in length is based on months, weeks or days. Allowed values:
|
||||||||||||
| renewal_duration_length | long | No |
The contract renewal duration in length that the given contract will be in effect from the renewal start date. Alternative field: renewal_end_date |
|||||||||||||
| renewal_end_date | string | No |
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 |
Outputs
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| error_code | long | No |
Aria-assigned error identifier. 0 indicates no error. |
|
| error_msg | string | No |
Description of any error that occurred. "OK" if there was no error. |
|
| contract_no | long | No |
Aria-assigned unique contract identifier |