The get_plan_details_m API returns details for the specified service plan.
| API Specification: |
get_plan_details_m
|
| Required Fields: |
- <client_no>
- <auth_key>
- <plan_no> or <client_plan_id>
|
Additional Guidance
Input Fields
| Field Name |
Notes |
| <include_translations> |
Allowable values
| Values |
Description |
| true |
Translated fields will be fetched in all the locales defined. |
| false |
Translation information will not be fetched. |
|
| <include_rs_summary> |
If set to "true", will retrieve summary level rate schedule information for all the rate schedules that are associated with a particular plan. If left blank, will default to "false".
Allowable values
| Values |
Description |
| true |
Rate schedule summary will be returned |
| false |
Rate schedule summary will not be returned |
|
| <is_advanced_usage_pricing> |
This parameter is included as part of the plan-level response.
Allowable Values
| Values |
Description |
| True |
Advanced Usage Pricing is turned on for the current plan.
Note: If True, to ensure error validation, reject any configurations involving: Pricing Rule, High Water Indicator, Advanced Billing Options, Billable Unit Threshold, Usage Rating Timing, Usage Record Rating Level, or Rate Tiers.
|
| False |
Advanced Usage Pricing is turned off. |
|
Output Fields
| Field Name |
Notes |
| <rollover_plan_uom_cd> |
Allowable values
| Values |
Description |
| 1 |
Day |
| 2 |
Week |
| 3 |
Month |
| 4 |
Quarter |
| 5 |
Year |
|
| <init_free_period_uom_cd> |
Allowable values
| Values |
Description |
| 1 |
Day |
| 2 |
Week |
| 3 |
Month |
| 4 |
Quarter |
| 5 |
Year |
|
| <rollover_plan_status_uom_cd> |
Allowable values
| Values |
Description |
| 1 |
Day |
| 2 |
Week |
| 3 |
Month |
| 4 |
Quarter |
| 5 |
Year |
|
| <active_ind> |
Allowable values
| Values |
Description |
| 0 |
Inactive |
| 10 |
Active |
|
| <item_scope> |
Allowable values
| Values |
Description |
| U |
Up to Plan Units. |
| M |
Match Plan Units. |
| A |
Any Units. |
|
| <active_ind> |
Allowable values
| Values |
Description |
| 0 |
Inactive |
| 10 |
Active |
|
| <nso_group_item_scope> |
Allowable values
| Values |
Description |
| U |
Up to Plan Units. |
| M |
Match Plan Units. |
| A |
Any Units. |
|
| <nso_incl_list_scope> |
Allowable values
| Values |
Description |
| 0 |
All non-restricted inventory items (default) |
| 1 |
Existing bundled and non-restricted inventory items |
| 2 |
Existing bundled inventory items only |
| 3 |
Selected and non-restricted inventory items |
| 4 |
Selected specific inventory items |
|
| <active_ind> |
Allowable values
| Values |
Description |
| 0 |
Inactive. |
| 1 |
Active. |
|
