Returns information for all services in a specified plan.
For information on error messages generated by this API, see get_client_plan_services_m Error Messages.
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 | The Aria-assigned unique identifier for the service associated with the 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-based 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 | The client-defined Service ID for this plan. |
![]() |
string | Denotes which usage type 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. |
![]() |
long | The Aria-assigned unique identifier for the origin location for the service. |
![]() |
string | The client-defined location identifier for the origin location for the service. |
![]() |
string | The name of the origin location for the service. |
![]() |
string | Company name of the service location. |
![]() |
string | First address line of the service location. |
![]() |
string | Second address line of the service location. If you want to delete existing data in this field, leaving it blank, you must enter a '~' in this field. |
![]() |
string | Third address line of the service location. |
![]() |
string | City of the service location. |
![]() |
string | Locality of the service location. |
![]() |
string | State or Province of the service location. The official postal-service codes for all United States, Australia and Canada states, provinces, and territories. This field does not support states, provinces or territories from other countries. Use the locality field for other countries. |
![]() |
string | Country of the location contact. The ISO-compliant 2-character country code abbreviation in uppercase. |
![]() |
string | Postal/Zip code for the service location address. |
![]() |
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 |
![]() |
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 |
![]() |
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 | The services for this plan |
![]() |
string | The client-defined identifier for the service associated with the 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. |
![]() |
long | The Aria-assigned unique identifier for the origin location for the service. |
![]() |
string | The client-defined location identifier for the origin location for the service. |
![]() |
string | The name of the origin location for the service. |
![]() |
string | Company name of the service location. |
![]() |
string | First address line of the service location. |
![]() |
string | Second address line of the service location. If you want to delete existing data in this field, leaving it blank, you must enter a '~' in this field. |
![]() |
string | Third address line of the service location. |
![]() |
string | City of the service location. |
![]() |
string | Locality of the service location. |
![]() |
string | State or Province of the service location. The official postal-service codes for all United States, Australia and Canada states, provinces, and territories. This field does not support states, provinces or territories from other countries. Use the locality field for other countries. |
![]() |
string | Country of the location contact. The ISO-compliant 2-character country code abbreviation in uppercase. |
![]() |
string | Postal/Zip code for the service location address. |
![]() |
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 |
![]() |
long |
Indicator that states whether a taxable service is tax-inclusive or tax-exclusive. 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. |