Skip to main content
Aria Knowledge Central

create_new_plan_m Guide

  1. Last updated
  2. Save as PDF

The create_new_plan_m API creates a service plan for specified client. 

API Specification:

create_new_plan_m
Required Fields:
  • <client_no>
  • <auth_key>
  • <plan_name>
  • <plan_type>
  • <currency>
  • <active>
  • <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).
Input Fields     
Field Name Notes
<tax_group> This field cannot be NULL if the field <taxable_ind> is 1 (indicating taxable).
<plan_type>
Allowable Values
Values Description
Master Recurring Plan Master Recurring Plan
Master Pre-paid Plan Master Pre-paid Plan
Master Free Plan Master Free Plan
Supplemental Recurring Plan Supplemental Recurring Plan
Supplemental Free Plan Supplemental Free Plan
<active>
Allowable Values
Values Description
0 Inactive
1 Active
<is_default>
Allowable Values
Values Description
1, true/TRUE/t, yes/y Yes, this rate schedule is the default for this plan.
0, false/FALSE/f, no/n No, this rate schedule is not the default for this plan. 
<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 Usage Based
Recurring Recurring
Activation Activation
Order-Based Order-Based
Cancellation Cancellation
Minimum Fee Minimum Fee
Recurring Arrears Recurring Arrears
<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
Volume Discount Volume Discount
Flat Rate Per Tier Flat Rate Per Tier
<high_water>
Allowable Values
Values Description
Yes Yes
No No
<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
<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
<expire_on_paid_through>
Allowable Values
Values Description
0 No
1 Yes
<reset_on_update>
Allowable Values
Values Description
0 No
1 Yes
<template_ind>
Allowable Values
Values Description
0, false/FALSE/f, no/n Doesn't create a plan as a template
1, true/TRUE/t, yes/y Creates a plan as a template
<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 anniversary date
<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.
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