get_client_plan_services_m Guide
- Last updated
-
-
Save as PDF
Returns information for all services in a specified plan.
Error Codes:
| Error Code/Description |
Associated Inputs |
|
|
|
1004: authentication error
Associated Inputs: auth_key, client_id, client_no
|
<auth_key>, <client_id>, <client_no> |
14004: Invalid_plan_no
Associated Inputs: new_plan_no, rollover_plan_no
|
<new_plan_no>, <rollover_plan_no> |
14035: Invalid client Plan id
Associated Inputs: client_plan_id, custom_rate_client_plan_instance_id
|
<client_plan_id>, <custom_rate_client_plan_instance_id> |
Additional Guidance
Output Fields
| Field Name |
Notes |
| <is_recurring_ind> |
Allowable values
| Values |
Description |
| 0 |
Service is not recurring-based. |
| 1 |
Service is recurring-based. |
|
| <is_usage_based_ind> |
Allowable values
| Values |
Description |
| 0 |
Service is not usage-based. |
| 1 |
Service is usage-based. |
|
| <taxable_ind> |
Allowable values
| Values |
Description |
| 0 |
Service is not taxable. |
| 1 |
Service is taxable. |
|
| <is_tax_ind> |
Allowable values
| Values |
Description |
| 0 |
Service is not a tax-based service. |
| 1 |
Service is a tax-based service. |
|
| <is_arrears_ind> |
Allowable values
| Values |
Description |
| 0 |
Service is not arrears-based. |
| 1 |
Service is arrears-based. |
|
| <is_setup_ind> |
Allowable values
| Values |
Description |
| 0 |
Service is not setup-based. |
| 1 |
Service is setup-based. |
|
| <is_misc_ind> |
Allowable values
| Values |
Description |
| 0 |
Service is not miscellaneous. |
| 1 |
Service is miscellaneous. |
|
| <is_donation_ind> |
Allowable values
| Values |
Description |
| 0 |
Service is not donation-based. |
| 1 |
Service is donation-based. |
|
| <is_order_based_ind> |
Allowable values
| Values |
Description |
| 0 |
Service is not order-based. |
| 1 |
Service is order-based. |
|
| <is_cancellation_ind> |
Allowable values
| Values |
Description |
| 0 |
Service is not cancellation-based. |
| 1 |
Service is cancellation-based. |
|
| <display_ind> |
Allowable values
| Values |
Description |
| 0 |
Service is not displayable. |
| 1 |
Service is displayable. |
|
| <tiered_pricing_rule> |
Allowable values
| Values |
Description |
| 1 |
Standard |
| 2 |
Volume Discount |
| 3 |
Flat Rate Per Tier |
|
| <is_min_fee_ind> |
Allowable values
| Values |
Description |
| 0 |
Service is not a minimum fee. |
| 1 |
Service is a minimum fee. |
|
| <future_rate> |
Allowable values
| Values |
Description |
| 0 |
false, i.e., no future rate. |
| 1 |
True, i.e., future rates are captured. |
| |
null, i.e., no future rate. |
|
| <apply_usage_rates_daily> |
Allowable values
| Values |
Description |
| 0 |
usage shall be rated based on the entire billing period |
| 1 |
usage shall be rated based on one day periods individually. |
|
| <is_recurring_ind> |
Allowable values
| Values |
Description |
| 0 |
0 |
| 1 |
1 |
|
| <is_usage_based_ind> |
Allowable values
| Values |
Description |
| 0 |
0 |
| 1 |
1 |
|
| <taxable_ind> |
Allowable values
| Values |
Description |
| 0 |
0 |
| 1 |
1 |
|
| <is_tax_ind> |
Allowable values
| Values |
Description |
| 0 |
0 |
| 1 |
1 |
|
| <is_arrears_ind> |
Allowable values
| Values |
Description |
| 0 |
0 |
| 1 |
1 |
|
| <is_setup_ind> |
Allowable values
| Values |
Description |
| 0 |
0 |
| 1 |
1 |
|
| <is_misc_ind> |
Allowable values
| Values |
Description |
| 0 |
0 |
| 1 |
1 |
|
| <is_donation_ind> |
Allowable values
| Values |
Description |
| 0 |
0 |
| 1 |
1 |
|
| <is_order_based_ind> |
Allowable values
| Values |
Description |
| 0 |
0 |
| 1 |
1 |
|
| <is_cancellation_ind> |
Allowable values
| Values |
Description |
| 0 |
0 |
| 1 |
1 |
|
| <display_ind> |
Allowable values
| Values |
Description |
| 0 |
0 |
| 1 |
1 |
|
| <tiered_pricing_rule> |
Allowable values
| Values |
Description |
| 1 |
Standard |
| 2 |
Volume Discount |
| 3 |
Flat Rate Per Tier |
|
| <is_min_fee_ind> |
Allowable values
| Values |
Description |
| 0 |
0 |
| 1 |
1 |
|
| <apply_usage_rates_daily> |
Allowable values
| Values |
Description |
| 0 |
usage shall be rated based on the entire billing period |
| 1 |
usage shall be rated based on one day periods individually. |
|
| <tax_inclusive_ind> |
Allowable values
| Values |
Description |
| 0 |
The service is tax-exclusive. |
| 1 |
The service is tax-inclusive. |
|
