Skip to main content
Aria Knowledge Central

edit_plan_m Guide

  1. Last updated
  2. Save as PDF

The edit_plan_m API edits a service plan for specified client.

API Specification:

edit_plan_m
Required Fields:
  • <client_no>
  • <auth_key>
  • <plan_no> or <client_plan_id>
  • <schedule> (array)
    • <schedule_name>
    • <currency_cd>
    • <is_default>
  • <service> (array)
    • <service_type>
    • <tier> (array)
      • <schedule> (array)
        • <amount>

Additional Guidance

  • You can pass a future rate change and track rate schedule versions assuming:
    • VERSIONING_ENABLED is set to TRUE in your Aria instance, and
    • You pass values in the fields <future_rate> (the future price) and <future_change_dt> (the date of the rate change).
    • See the full specification for additional relevant fields.
Input Fields 
Field Name Notes
<plan_type>
Allowable Values
Values Description
Master Recurring Plan This type creates a Master Recurring Plan
Master Pre-paid Plan This type creates a Master Pre-paid Plan
Master Free Plan This type creates a Master Free Plan
Supplemental Recurring Plan This type creates a Supplemental Recurring Plan
Supplemental Free Plan This type creates a Supplemental Free Plan
<active>
Allowable Values
Values Description
0 Inactive
1 Active
<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
<apply_cancellation>
Allowable Values
Values Description
Yes If set as Yes, minimum cancellation service can be added
No If set as No, minimum cancellation service cannot be added
<apply_minimum_fee>
Allowable Values
Values Description
Yes If set as Yes, minimum fee service can be added
No If set as No, minimum fee service cannot be added
<how_to_apply_min_fee>
Allowable Values
Values Description
0 All Invoices
1 After first invoice
<is_default>
Allowable Values
Values Description
1, true/TRUE/t, yes/y Yes, this currency is the default.
0, false/FALSE/f, no/n No, this currency is not the default. 
<future_rate>
Allowable Values
Values Description
1, true/TRUE/t, yes/y Yes, future rates are supported..
0, false/FALSE/f, no/n No, future rates are not supported.
<service_type>
Allowable Values
Values Description
Usage Based Creates a Usage Based service
Recurring Creates a Recurring service
Activation Creates a Activation service
Order-Based Creates a Order-Based service
Cancellation Creates a Cancellation service
Minimum Fee Creates a Minimum Fee service
Recurring Arrears Creates a Recurring Arrears service
<rate_type>
Allowable Values
Values Description
Flat Rate Applies Flat Rate type pricing to the rate schedule
Tiered Pricing Applies Tiered Pricing to the rate schedule
<pricing_rule>
Allowable Values
Values Description
Standard Standard Pricing
Volume Discount Volume Discount Pricing
Flat Rate Per Tier Flat Rate Per Tier Pricing
<high_water>
Allowable Values
Values Description
1 Enables high water indicator for the particular service
0 Doesn't enable high water indicator for the particular service
<tax_inclusive_ind>
Allowable Values
Values Description
0, false/FALSE/f, no/n No, applied rate does not include taxes.
1, true/TRUE/t, yes/y Yes, applied rate includes taxes.
<notice_dest_type>
Allowable Values
Values Description
S Master Plan Instance level threshold
C Client level threshold
<notice_balance_type>
Allowable Values
Values Description
MTD Month-To-Date balance type
PTD Period-To-Date balance type
<values>
Allowable Values
Values Description
1 1
2 2
3 3
4 4
<fulfillment_based_ind>
Allowable Values
Values Description
0 Not a fulfillment based service
1 Fulfillment based service
<usage_rating_time_ind>
Allowable Values
Values Description
0 Refers to the setting you have on client parameter "Automatically Rate Un-rated Usage Records at Load Time"
1 At Loading Time
2 At Invoicing Time
<usage_record_rating_level_ind>
Allowable Values
Values Description
0 Aggregated Records
1  Individual Records
<usage_record_taxation_level_ind>
Allowable Values
Values Description
0 Aggregated Records
1  Individual Records
<expire_on_paid_through>
Allowable Values
Values Description
0 No
1 Yes
<reset_on_update>
Allowable Values
Values Description
0 No
1 Yes
<is_mandatory>
Allowable Values
Values Description
0 Non Mandatory
1 Mandatory
<include_default>
Allowable Values
Values Description
0 No
1 Yes
<enforcement_level>
Allowable Values
Values Description
0 For each parent plan unit or Instance individually (default)
1 In aggregate across all units and instances of this parent plan on the Account
<proration_invoice_timing_cd>
Allowable Values
Values Description
I Immediate
A Next anniversary date
<plan_instance_status_cd>
Allowable Values
Values Description
1 Active
61 Active Non Billable
41 Active trial
31 Installation Pending
<field_category_directive>
Allowable Values
Values Description
1 Adds a field_category to the plan
2 Deletes the field_category from the plan
<edit_directives>
Allowable Values
Values Description
1 Delete data that is not passed in the request (default)
2 Insert or update data passed but DO NOT delete data not passed
3 Delete everything that is passed.
<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.
<nso_group_item_scope>
Allowable Values
Values Description
U Up to Plan Units (default).
M Match Plan Units.
A Any Units.
<item_scope>
Allowable Values
Values Description
U Up to Plan Units (default).
M Match Plan Units.
A Any Units.
<subscription_type>
Allowable Values
Values Description
N New Subscription
E Existing Subscription
<effective_directive>
Allowable Values
Values Description
N Effective Prior to Next Batch Billing Run
A On Account Billing Anniversary Date
<is_advanced_usage_pricing>
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.

Error Codes

Error Code/Description Associated Inputs

1001: unexpected error

  

1010: missing required parameters, Missing input: (object-name) is required with assignment_directive ($AriaNo)

<plan_no> or <client_plan_id>

1016: invalid input

Additional Comments:  This error can be caused by the wrong type of input; for example, text in a numbers-only field, or specifying a value other than one of the documented allowable values.

<plan_no> or <client_plan_id>, <plan_instance_status_cd>,<fulfillment_based_ind>

1024: invalid date format

Additional Comments: All date inputs must be in yyyy-mm-dd format.

<available_start_dt>, <available_to_dt>, <future_change_dt>, <effective_date>
TOP
  1. Back to top
  • Was this article helpful?

Recommended articles

  1. Page type
    Topic
  2. Tags
    1. admintools api
    2. API Guide
    3. pricing
    4. rate schedule
    5. rates
    6. versioning