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. |
plan_no | long | Aria-assigned plan identifier. This value is unique across all Aria-managed accounts. | ||
OR | ||||
client_plan_id | string | 100 | Client-defined Plan ID for which to query available child plans | |
acct_no | long | 38 | Aria-assigned account identifier. This value is unique across all Aria-managed accounts. | |
promo_code | string | 30 | 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. | |
parent_plan_no | long | Aria-assigned unique plan identifier for the parent plan | ||
OR | ||||
client_parent_plan_id | string | 100 | Client-defined unique parent Plan ID | |
![]() | string array | 300 | An array of client-specified supplemental field names | |
![]() | string array | 1000 | An array of client-specified supplemental field values corresponding to the names above | |
include_all_rate_schedules | string | 5 | If set to "true", will retrieve all of the rates and rate schedules associated with a particular plan. If left blank, will default to "false". Allowable Values | |
include_plan_hierarchy | string | 5 | You can use this input parameter to specify whether to retrieve the child plans associated with the returned plans or with the plan_no or parent_plan_no that you specified. If you set the include_plan_hierarchy parameter to true , then all of the child plans down to the bottom level of your plan hierarchy will be returned. Allowable Values |
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. |
all_client_plans | hash | A multidimensional array containing all client plans. |
![]() | 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 assigned unique plan identifier |
![]() | string | Pre-defined client rollover plan ID 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 | Indicates whether to defer the pro-rated charges to the next anniversary date or to create a seperate invoice immediately. Allowable Values |
![]() | hash | A multidimensional array of Services for this plan |
![]() | long | A multidimensional array of Services for this plan |
![]() | string | Description of this service |
![]() | long | Indicates whether or not this service is a recurring service Allowable Values |
![]() | long | Indicates whether or not this service is a usage based service Allowable Values |
![]() | long | The usage type supported by this usage based service |
![]() | long | Indicates whether or not this service is taxable Allowable Values |
![]() | long | Indicates whether or not this service is a tax based service Allowable Values |
![]() | long | Indicates whether or not this service is an arrears based service Allowable Values |
![]() | long | Indicates whether or not this service is a setup bases service Allowable Values |
![]() | long | Indicates whether or not this service is a miscellaneous service Allowable Values |
![]() | long | Indicates whether or not this service is a donation based service Allowable Values |
![]() | long | Indicates whether or not this service is an order based service Allowable Values |
![]() | long | Indicates whether or not this service is a cancellation based service Allowable Values |
![]() | string | Chart of accounts ID |
![]() | string | This field is deprecated in favor of coa_id |
![]() | string | The client-defined override for coa_id |
![]() | long | Indicates if this service is displayable or not Allowable Values |
![]() | long | The Tiered Pricing Rule Allowable Values |
![]() | long | Indicates whether or not this service is a minimum fee. Allowable Values |
![]() | string | A multidimensional array of client-defined Service ID for this plan. |
![]() | string | An array containing usage_type_cd(s) to denote which usage type(s) to record. |
![]() | hash | |
![]() | string | The machine-readable name of this field |
![]() | string | The human-readable name of this field |
![]() | long | The sort order of this field |
![]() | string | The value stored in this field |
![]() | long | Indicates if the service is Fulfillment Based or not. |
![]() | hash | Represents the rates for the default rate schedule for the default currency for the plan |
![]() | long | Sequential number in the rate schedule for dertermining tiers |
![]() | double | Tiered Units (from) This value represents the start of a tiered range of values. |
![]() | double | Tiered Units (to) This value represents the end of the range for a single tier of values. |
![]() | double | The cost per unit of this service over the time period the plan is billed for |
![]() | double | The future cost per unit of this service over the time period the plan is billed for |
![]() | double | If the plan interval is more than one month, this field will rate per unit per month |
![]() | string | Client assigned unique rate schedule number |
![]() | string | Rate Tier Description |
![]() | hash | All rates for all rate schedules and currencies for this plan |
![]() | long | Rate schedule number |
![]() | string | Client assigned unique rate schedule number |
![]() | long | Indicates whether future rates are captured or not. Allowable Values |
![]() | string | Future Change Date of the rates. |
![]() | long | Aria internal id of follow-up default rate schedule |
![]() | string | Client defined id of followup rate schedule |
![]() | hash | Represents the rates for the default rate schedule for the default currency for the plan |
![]() | long | Sequential number in the rate schedule for dertermining tiers |
![]() | double | Tiered Units (from) This value represents the start of a tiered range of values. |
![]() | double | Tiered Units (to) This value represents the end of the range for a single tier of values. |
![]() | double | The cost per unit of this service over the time period the plan is billed for |
![]() | double | The future cost per unit of this service over the time period the plan is billed for |
![]() | double | If the plan interval is more than one month, this field will rate per unit per month |
![]() | string | Client assigned unique rate schedule number |
![]() | string | Rate Tier Description |
![]() | string | The human-readable name of this usage type |
![]() | string | The long description of this usage type |
![]() | string | Client-assigned identifier for the type of usage being recorded. |
![]() | string | The display-level description of the units this usage represents. |
![]() | long | Indicates whether or not this usage-based service is rated on a daily basis. Allowable Values |
![]() | hash | All the rate schedules associated with this plan |
![]() | long | The ID of this rate schedule |
![]() | string | The name of this rate schedule |
![]() | string | The currency this rate schedule is linked to |
![]() | long | If true, this is the default rate schedule for the default currency Allowable Values |
![]() | long | If true, this is the default rate schedule for the specified currency |
![]() | long | Determines whether the rate schedule is displayable Allowable Values |
![]() | string | Client assigned unique rate schedule number |
![]() | string | Start date of rate schedule |
![]() | string | End date of rate schedule |
![]() | long | Indicates whether future rates are captured or not Allowable Values |
![]() | string | Future Change Date of the rates. |
![]() | long | Aria internal id of follow-up default rate schedule |
![]() | string | Client defined id of followup rate schedule |
![]() | hash | A grouping of plans which can be used for plan assignment |
![]() | long | The ID of this plan group |
![]() | string | The name of this plan group |
![]() | string | The long description of this plan group |
![]() | string | Determines where the plan groups are made available Allowable Values |
![]() | long | Whether or not this plan group is selectable Allowable Values |
![]() | string | Client-defined ID for this plan group |
![]() | hash | A grouping of plans based on promo code |
![]() | long | The ID of this promotional plan set |
![]() | string | The name of this promotional plan set |
![]() | string | The long description of this promotional plan set |
![]() | hash | The promo codes associated with this group of plans |
![]() | string | The promo code itself |
![]() | string | A long description of this promo code |
![]() | string | Client-defined ID of this promotional plan set |
![]() | hash | The plans which are mapped as parents of this plan |
![]() | long | ID of the parent plan |
![]() | string | Name of the parent plan |
![]() | string | Client-defined unique parent Plan ID |
![]() | hash | Supplemental object fields associated with this plan |
![]() | long | Supplemental object field ID |
![]() | string | Name of the supplemental object field |
![]() | string | Description of the supplemental object field |
![]() | string | The value in this supplemental field on the plan |
![]() | string | If true, this plan met the initial filtering criteria used to retrieve this list of plans. If false, this plan is a child plan (or other decendant) of a plan which met the initial criteria Allowable Values |
![]() | hash | The plans which are mapped as children of this plan |
![]() | long | Aria-assigned plan identifier. This value is unique across all Aria-managed accounts. |
![]() | string | Client-defined Plan ID for which to query available child plans |