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 | 22 | The unique plan identifier. | |
OR | ||||
client_plan_id | string | 100 | Client-defined Plan ID for which to query available child plans |
Field Name | Field Type | Description |
---|---|---|
plan_services | hash | Deprecated 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 |
plan_services_list | hash | A multidimensional array of Services for this plan |
![]() | long | A multidimensional array of Services for this plan |
![]() | string | A multidimensional array of client-defined Service ID 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 |
![]() | long | Indicates if the service is Fulfillment Based or not. |
![]() | 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 |
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. |