Req | Field Name | Field Type | Max Length | Description |
---|---|---|---|---|
![]() | client_no | long | 22 | Aria-assigned unique identifier indicating the Aria client providing service to this account. |
![]() | auth_key | string | 32 | Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor. |
![]() | promo_code | string | 255 | This is the code provided the client and used by the account holder during registration or when executing a transaction.A promotion generally provides access to a custom set of reduced-rate plans. |
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. | |
optional_transaction_qualifiers | array | Array of additional values you can associate with this API call. | ||
![]() | string | 100 | Name of the field you want to associate with this API call. | |
![]() | string | 100 | Corresponding value of the field you want to associate with this API call. |
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. |
plans | hash | |
![]() | long | Aria-assigned unique plan identifier |
![]() | string | Plan Name |
![]() | string | Text description of this plan |
![]() | long | Indicates whether or not this plan is a supplemental plan. Allowable Values |
![]() | long | Number of months between billing cycles |
![]() | long | Indicates whether or not this plan is billable Allowable Values |
![]() | long | Indicates whether or not the plan is marked as "displayable". 0 means not displayable. 1 means displayable. Allowable Values |
![]() | long | Number of months in which the account will change from the current plan to the pre-defined rollover plan. |
![]() | long | Pre-defined plan to which the account will change based on the defined rollover_months value; the rollover record is created when an account is placed on a plan with a defined rollover plan. |
![]() | double | Fee charged for early cancellations. |
![]() | long | Number of months during which early cancellation fees would apply on plan cancellation. |
![]() | long | Pre-defined period in days in which an account will degrade to Suspended status (-1) if action is not taken such as a plan or status change. |
![]() | long | The status code to assert for the new account. Allowable Values |
![]() | long | Default status for new accounts created on this plan. Allowable Values |
![]() | long | Number of days in which an account will change from the initial status code to the pre-defined rollover status code. |
![]() | long | Initial free months. |
![]() | long | Plan to assign when an account on this plan is suspended. |
![]() | long | Default notification method given to an account that is assigned to this plan. Allowable Values |
![]() | long | Indicates whether or not this plan is prepaid Allowable Values |
![]() | string | The 3-character ISO-compliant currency code in lowercase for monetary values used in the context of this API method. |
![]() | string | Client-defined Plan ID for which to query available child plans |
![]() | string | Pre-defined plan to which the account will change based on the defined rollover_months value; the rollover record is created when an account is placed on a plan with a defined client rollover plan ID. |
![]() | string | Client-defined Plan identifier to assign when an account on this plan is suspended. |
![]() | string | Indicates whether to defer the pro-rated charges to the next anniversary date or to create a seperate invoice immediately. Allowable Values |