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. |
![]() |
acct_no | long | 22 | Aria-assigned account identifier. This value is unique across all Aria-managed accounts. |
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. |
acct_plans | hash | |
![]() |
long | Aria-assigned unique plan identifier |
![]() |
string | Plan Name |
![]() |
string | Text description of this plan |
![]() |
string | Date on which the account was assigned to their current plan. |
![]() |
long | Number of plan units the account is billed for. |
![]() |
long | Number of plan units the account is queued to change to on "units_change_date". |
![]() |
string | The date queued units are effective |
![]() |
string | The date the account was last billed |
![]() |
string | Date the account will be evaluated for invoicing, whether or not it results in any actual charges. |
![]() |
string | Date the accounts forward charges have been billed through. |
![]() |
long | Day of month the account is billed on. |
![]() |
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 of new accounts subscribing to this plan 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. |
![]() |
long | Aria-assigned unique rate schedule number |
![]() |
string | Name of the rate schedule |
![]() |
long | Indicates whether or not the account is using the plans default rate schedule. 0 means the account is using an alternate rate schedule. 1 means the account is using the default rate schedule. Allowable Values |
![]() |
string | Start date of rate schedule |
![]() |
string | End date of rate schedule |
![]() |
long | Aria internal id of follow-up default rate schedule |
![]() |
string | Client defined id of followup rate schedule |
![]() |
long | Indicates whether or not the plan is a supplemental plan. If it is "1", then the plan is a supplemental plan and if it is "0", then the plan is a master plan. Allowable Values |
![]() |
long | The status code of the supplemental plan associated with this account. Allowable Values |
![]() |
string | The status code of the supplemental plan returned by the API method. Allowable Values |
![]() |
string | The date of the most recent status change on the account due to this supplemental plan |
![]() |
string | The activation date of this supplemental plan |
![]() |
string | The termination date, if any, of this supplemental plan |
![]() |
string | Client-defined unique identifier used to track related system actions |
![]() |
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 | Client assigned unique rate schedule number |
![]() |
string | Indicates whether to defer the pro-rated charges to the next anniversary date or to create a seperate invoice immediately. Allowable Values |
![]() |
long | For each plan specified, the number of months to accumulate before being reset. |
![]() |
long | Determines whether the usage accumulation reset months will automatically reset to same value at the end of the current period or will expire at the end of the current period. Allowable Values |
![]() |
long | Number of months since last reset. Once this this value reaches the <usage_accumulation_reset_months> value, it will reset to 0 (zero) |