get_client_plan_service_rates_m
Summary
| API Name | get_client_plan_service_rates_m |
|---|---|
| Class | system_services_m |
| Update Version | 6.31 |
Description
Returns information about the rates for a particular service in a specified plan.
Inputs
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| client_no | long | 22 | Yes |
Aria-assigned unique identifier indicating the Aria client providing service to this account. |
| auth_key | string | 32 | No |
Aria-assigned unique key for authenticating the validity of the requestor. This key is passed with each method call. |
| plan_no | long | 22 | No |
The unique plan identifier. Alternative field: client_plan_id |
| service_no | long | 22 | No |
Aria-assigned unique service identifier Alternative field: client_service_id |
| alt_rate_schedule_no | long | 22 | No |
Alternative Rate Schedule Number. The alt_rate_schedule_no is the unique identifier for an alternative rate schedule that can be assigned to the account holder in place of the default rate schedule. This is often done by CSR's to provide special compensation or discounts as incentives to account holders. Alternative field: client_alt_rate_schedule_id |
| client_plan_id | string | 100 | No |
Client-defined Plan ID for which to query available child plans Alternative field: plan_no |
| client_service_id | string | 100 | No |
A multidimensional array of client-defined Service ID for this plan. Alternative field: service_no |
| client_alt_rate_schedule_id | string | 100 | No |
Client-defined alternate rate schedule number to assign (if any). If none is specified, the default rate schedule number will be used. Alternative field: alt_rate_schedule_no |
Outputs
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| plan_service_rates | object | No |
Represents the rates for the default rate schedule for the default currency for the plan |
|
| error_code | long | No |
Aria-assigned error identifier. 0 indicates no error. |
|
| error_msg | string | No |
Description of any error that occurred. "OK" if there was no error. |
plan_service_rates fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| rate_seq_no | long | No |
Sequential number in the rate schedule for dertermining tiers |
|
| from_unit | double | No |
Tiered Units (from) This value represents the start of a tiered range of values. |
|
| to_unit | double | No |
Tiered Units (to) This value represents the end of the range for a single tier of values. |
|
| rate_per_unit | double | No |
The cost per unit of this service over the time period the plan is billed for |
|
| future_rate_per_unit | double | No |
The future cost per unit of this service over the time period the plan is billed for |
|
| monthly_fee | double | No |
If the plan interval is more than one month, this field will rate per unit per month |
|
| weekly_fee | double | No |
If the plan interval is more than one week, this field will rate per unit per week |
|
| daily_fee | double | No |
If the plan interval is more than one day, this field will rate per unit per day |
|
| client_rate_schedule_id | string | 100 | No |
Client assigned unique rate schedule number |
| rate_tier_description | string | 50 | No |
Rate Tier Description |