Search the Aria Knowledgebase for
User Documentation, APIs, SDKs, and more!



 

Home > Aria Crescendo admintools api > create_new_plan_m

create_new_plan_m

Creates a service plan for specified client

Input Arguments

Req Field Name Field Type Max Length Description
required-icon.png client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
required-icon.png auth_key string 32 Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.
required-icon.png plan_name string 100 Specifies Plan Name. Translatable.
required-icon.png plan_type string   Specifies Plan Type. Valid values are [ 'Master Recurring Plan', 'Master Pre-paid Plan', 'Master Free Plan', 'Supplemental Recurring Plan', 'Supplemental Free Plan']   Allowable Values
required-icon.png currency string 3 Specifies the currency code of plan
required-icon.png active int 1 Specifies if inventory item is active or inactive. Valid values are: 0 - Inactive and 1 - Active   Allowable Values
required-icon.png schedule array    
required-icon.png brd_arrow.gifschedule_name string 100 Name for the schedules to be created. REST input arrays should passed in the following format: schedule[0][schedule_name]=firstSchedule&schedule[1][schedule_name]= secondSchedule etc where schedule[0] specifies first schedule and schedule[1] specifies the second schedule and so on. Translatable.
required-icon.png brd_arrow.gifcurrency_cd string 3 Currency for the schedules to be created. REST input arrays should passed in the following format: schedule[0][currency_cd]=usd&schedule[1][currency_cd]=gbp
  brd_arrow.gifclient_rate_schedule_id string 100 Client defined unique id
required-icon.png brd_arrow.gifis_default boolean 1 This flag denotes if this rate schedule is the default one for this plan. One and only one rate schedule can be marked as default. The value of 1 is defaulted for the first rate schedule denoting it is the default. For subsequent rate schedules, the default is set to 0.
  brd_arrow.gifrecurring_billing_interval int 100 If a null/no value is provided then recurring_billing_interval should default to 1, i.e., monthly interval.Recurring Billing Interval [ can be either of 1, 3, 6 or 12, ) 1 – Monthly, 3 – Quarterly, 6 - Semi-Annually, 12 – Annually, Custom -
  brd_arrow.gifusage_billing_interval int 100 If null/no value is provided then usage_billing_interval should default to 1, i.e., monthly interval.Usage Billing Interval [ can be either of 1, 3, 6 or 12, ) 1 – Monthly, 3 – Quarterly, 6 - Semi-Annually, 12 – Annually, Custom -
  brd_arrow.gifavailable_from_dt string 10 Date from which the rate schedule will be available for the assignment. The date format must be yyyy-mm-dd
  brd_arrow.gifavailable_to_dt string 10 Date after which the rate schedule will not be available for the assignment. The date format must be yyyy-mm-dd
  brd_arrow.giffuture_rate boolean 1 Indicator whether future rates should be supported or not
  brd_arrow.giffuture_change_dt string 10 Date after which the future rates should be assigned. The date format must be yyyy-mm-dd
  brd_arrow.giffollowup_rs_no long 100 Aria internal id of follow-up default rate schedule
  OR      
  brd_arrow.gifclient_followup_rs_id string 100 Client defined id of followup rate schedule. One of the values, i.e., either followup_rs_no or client_followup_rs_id should be provided if a followup rate schedule information should be provided.
required-icon.png service array    
  brd_arrow.gifservice_no int 100 Existing service to be associated with the plan. To create a new service, leave this field blank. REST input arrays should be passed in the following format: service[0][service_no]=125&service[1][service_no]=102 etc where service[0] specifies the first service and service[1] specifies the second service
  OR      
  brd_arrow.gifclient_service_id string 100 Client defined unique id
  brd_arrow.gifname string 100 Name of the new service to be associated with the plan. This field cannot be null if service_no is null. REST input arrays should be passed in the following format: service[0][name]=test. Translatable.
required-icon.png brd_arrow.gifservice_type string   Specifies Service types. Valid values are: "Usage Based", "Recurring", "Activation"   Allowable Values
  brd_arrow.gifgl_cd string 30 Specifies the chart of account code of the new service. REST input arrays should be passed in the following format: service[0][gl_cd]=gl123
  brd_arrow.giftaxable_ind string 1 Indicates If The service has tax associated with it [can be 0 or 1]; 1 indicates taxable and 0 indicates non taxable.REST input arrays should be passed in the following format: service[0][taxable_ind]=1
  brd_arrow.giftax_group string 1 Specifies the tax group associated with the new service. This field cannot be null if taxable_ind is not null.REST input arrays should be passed in the following format: service[0][tax_group]=4
  brd_arrow.gifusage_type int 38 Specifies usage type associated with the new service. Applicable only if service_type is "Usage-Based". This field cannot be null if service_no is null and service_type is "Usage-Based".REST input arrays should be passed in the following format: service[0][usage_type]=1232&
  brd_arrow.gifcommodity_cd string 20 Commodity Code
  brd_arrow.gifrate_type string   Specifies the rate type of the service.If service_type = "Recurring", valid values are: 'Flat Rate' and 'Tiered Pricing'. This field cannot be null if service_no is null. If service_no is not null, rate_type of the service will be updated.If service_type = "Activation" or "Cancellation", value is defaulted to "Flat Rate" If service_type = "Usage-Based", value is defaulted to "Tiered Pricing".REST input arrays should be passed in the following format: service[0][rate_type]=Flat Rate&service[1][rate_type]=...   Allowable Values
  brd_arrow.gifpricing_rule string   Specifies the pricing rule of the service. Valid values are: 'Standard', 'Volume Discount' and 'Flat Rate Per Tier'. This field cannot be null if service_no is null and rate_type set to "Tiered Pricing". If service_no is not null and rate_type = "Tiered Pricing", pricing_rule of the service will be updated. REST input arrays should be passed in the following format. service[0][pricing_rule]=Standard&...   Allowable Values
  brd_arrow.gifhigh_water int   Specifies the high water indicator of the service if service_type = "Usage-Based". Valid values: 0 and 1. Default value is 0. If service_no is not null, high_water indicator of the service will be updated. REST input arrays should be passed in the following format: service[0][high_water]=0&service[1][high_water]=1&...   Allowable Values
  brd_arrow.giftax_inclusive_ind boolean 1 This flag denotes if a rate is inclusive of the taxes. Value of 1 means tax inclusive rates and a value of 0 (default) means tax exclusive rates.
  brd_arrow.gifusage_threshold array   Threshold units at the usage type level
  brd_arrow.gifnotice_dest_type string   Notice Destination type. Acceptable values are S, C. Parameter is case insensitive.   Allowable Values
  brd_arrow.gifnotice_balance_type string   Notice Balance type. Acceptable values are MTD, PTD. Parameter is case insensitive   Allowable Values
  brd_arrow.gifnotifications array    
  brd_arrow.gifunits int 9 Threshold units
  brd_arrow.gifvalues array   The key of the array represents the level and the value represents the value of the array represent the notification value. Valid key values are from 1 to 4   Allowable Values
required-icon.png brd_arrow.giftier array    
  brd_arrow.giffrom int 10 Tiered Pricing Rule that specifies from units. This field cannot be null if rate_type = "Tiered Pricing".REST input arrays should be passed in the following format: service[0][tier][0][from]=1&service[0][tier][1][from]=1 etc. Index [tier][0] specifies the first tier and [tier][1] specifies the second tier and so on.
  brd_arrow.gifto int 10 Tiered Pricing Rule that specifies to units. This field cannot be null if rate_type = "Tiered Pricing". To indicate no upper limit, value should be left blank.REST input arrays should be passed in the following format: service[0][tier][0][to]=3&service[0][tier][1][to]=7 etc. Index [tier][0] specifies the first tier and [tier][1] specifies the second tier and so on.
  brd_arrow.gifdescription string 50 This field is used to display custom rate tier description. REST input arrays should be passed in the following format: service[0][tier][0][schedule][0][description]=Custom description&service[0][tier][1][schedule][0][description]=custom description etc. Index [tier][0] specifies the first tier and [tier][1] specifies the second tier and so on. Translatable.
  brd_arrow.gifschedule array    
  brd_arrow.giffrom int 10 Tiered Pricing Rule that specifies from units at schedule level. This will override the rate tier's from units at service level. REST input arrays should be passed in the following format: service[0][tier][0][schedule][0][from]=1&service[0][tier][0] [schedule][1][from]=1 etc. Index [tier][0][schedule][0] specifies the first tier of first schedule and [tier][0][schedule][1] specifies the first tier of second schedule and so on.
  brd_arrow.gifto int 10 Tiered Pricing Rule that specifies to units at schedule level. This will override the rate tier's to units at service level. To indicate no upper limit, value should be left blank. REST input arrays should be passed in the following format: service[0][tier][0][schedule][0][to]=3&service[0][tier][0][schedule][1][to]=7 etc. Index [tier][0][schedule][0] specifies the first tier of first schedule and [tier][0][schedule][1] specifies the first tier of second schedule and so on.
  brd_arrow.gifdescription string 50 This field is used to display custom rate tier description. This will override the rate tier's description at service level. REST input arrays should be passed in the following format: service[0][tier][0][schedule][0][description]=Custom description &service[0][tier][0][schedule][1][description]=custom description etc. Index [tier][0][schedule][0] specifies the first tier of first schedule and [tier][0][schedule][1] specifies the first tier of second schedule and so on.
required-icon.png brd_arrow.gifamount float 11 Tiered Pricing Rule that specifies rate per unit.REST input arrays should be passed in the following format: service[0][tier][0][schedule][0][amount]=3&service[0][tier][0][ schedule][1] [amount]=4 etc where [schedule][0][amount] specifies price from first schedule and [schedule][1][amount] specifies price for second schedule and so on.
  brd_arrow.giffuture_amount float 11 Future Rate Per Unit for the tier. future_amount should be specified only if future_rate=1 and future_change_dt is specified. REST input arrays should be passed in the following format: service[0][tier][0][schedule][0][future_amount]=3&service[0][tier][0][schedule][1] [future_amount]=4 etc
  brd_arrow.giffulfillment_based_ind int 1 Indicates if the service is “Fulfillment Based” or not.   Allowable Values
  plan_description string 3000 Specifies plan description. Translatable.
  client_plan_id string 100 Client defined unique identifier
  plan_group int array 3 Plan Group Number.REST input arrays should be passed in the following format: plan_group[]=2&plan_group[]=3&plan_group[]=4
  plan_group_id string array 3 Plan Group Id Number.REST input arrays should be passed in the following format: plan_group_id[]=2&plan_group_id[]=3&plan_group_id[]=4
  rollover_plan_duration int   Duration of the plan rollover period (used in conjunction with rollover_plan_uom_cd).
  rollover_plan_uom_cd int   Units associated with the duration of the plan rollover period (used in conjunction with rollover_plan_duration).   Allowable Values
  rollover_plan_no int 100 Rollover Plan number
  OR      
  rollover_client_plan_id string 100 Client defined unique identifier
  init_free_period_duration int   Duration of the initial free period (used in conjunction with init_free_period_uom_cd).
  init_free_period_uom_cd int   Units associated with the duration of the initial free period (used in conjunction with init_free_period_duration).   Allowable Values
  initial_plan_status_cd int   Default status used when master plan is initially assigned on an account.
  rollover_plan_status_duration int   Duration of the plan status rollover period, after which the initial plan status on the master plan instance will change to the pre-defined rollover plan status (used in conjuction with rollover_plan_status_uom_cd).
  rollover_plan_status_uom_cd int   Units associated with the duration of the plan status rollover period after which the initial plan status on the master plan instance will change to the pre-defined rollover plan status (used in conjunction with rollover_plan_status_duration).   Allowable Values
  rollover_plan_status_cd int   Status used for the master plan instance at the completion of the plan status rollover period.
  dunning_plan_no int 100 Specifies dunning plan associated with this plan
  OR      
  dunning_client_plan_id string 100 Client defined unique identifier
  template_no int 8 Specifies invoice template class associated with master plan
  OR      
  client_email_template_id string 100 Client defined unique identifier.
  apply_cancellation string   Specifies whether to apply cancellation or not. Valid values: Yes or No. If marked as 'Yes' then should also provide at least one cancellation service   Allowable Values
  plan_cancel_min_month int 4 Specifies the minimum term months for cancellation service
  apply_minimum_fee string   Specifies whether to apply minimum fee or not. Valid values: Yes or No. If marked as 'Yes' then should also provide at least one minimum fee service.   Allowable Values
  how_to_apply_min_fee string   Specifies when to apply min fee. Valid values are 0 which means 'All Invoices' and 1 which means 'After first invoice'.   Allowable Values
  resource array    
  brd_arrow.gifresource_no int   Specifies the resource no of the resource to be added to a plan. REST input arrays should passed in the following format: resource[0][resource_no]=123&resource[1][resource_no]=232 etc where resource[0] specifies first resource and resource[1] specifies the second resource and so on.
  brd_arrow.gifresource_name string 100 Specifies the name of the resource to be created and assigned to this plan. REST input arrays should passed in the following format: resource[0][resource_name]=resource1&resource[1][resource_name]=test&...
  brd_arrow.gifresource_description string   Specifies the description of the resource to be created and assigned to this plan.REST input arrays should passed in the following format: resource[0][resource_description]=resource1&...
  brd_arrow.gifflat_threshold int 11 Specifies the name of the resource to be created and assigned to this plan. REST input arrays should passed in the following format: resource[0][flat_threshold]=11&resource[1][flat_threshold]=3&...
  brd_arrow.gifresource_units int 11 Specifies the number of units of the resource to be allocated.REST input arrays should passed in the following format: resource[0][resource_units]=23&resource[1][resource_units]=4&...
  brd_arrow.gifexpire_on_paid_through string   Specifies whether or not the resource will expire on paid through date. REST input arrays should passed in the following format: resource[0][expire_on_paid_through]=1&resource[1][expire_on_paid_through]=0&...   Allowable Values
  brd_arrow.gifadditional_days int 11 Specifies the number of days added to the paid_through_date if expire_on_paid_through is set if not then to the date when the plan is paid on. REST input arrays should passed in the following format: resource[0][additional_days]=2&resource[1][additional_days]=3&...
  brd_arrow.gifreset_on_update string   Resets the number of units after each paid through date.REST input arrays should passed in the following format: resource[0][reset_on_update]=1&resource[1][reset_on_update]=0&...   Allowable Values
  arc_service_no int   Specifies one of the recurring service for the plan to which the resource is being applied
  parent_plans int array 12 Specifies the parent plans to associate with. This is only applicable for supplemental plans.REST input arrays should be passed in the following format: parent_plans[]=1002&parent_plan[]=1003&parent_plan[]=1004&...
  parent_client_plan_ids string array 100 Specifies the parent plans to associate with. This is only applicable for supplemental plans.REST input arrays should be passed in the following format: parent_client_plan_ids[]=1002&parent_client_plan_ids[]=1003&parent_client_plan_ids[]=1004&...
  exclusion_plans int array 12 Specifies the exclusion plans. This is only applicable for supplemental plans. REST input arrays should be passed in the following format: exclusion_plans[]=2&exclusion_plans[]=3&exclusion_plans[]=4&...
  supplemental_obj_field array   Specifies the supplemental object fields to be added for this usage type
  brd_arrow.giffield_no int 100 the field no
  OR      
  brd_arrow.giffield_name string 100 the field name
  brd_arrow.giffield_value string array   the field value
  template_ind boolean 1 This flag is used to create a plan template. Value of 1 creates the plan as a template. Value of 0 (default) creates a regular plan.   Allowable Values
  child_plans string array   If the Plan has child plans, they can be passed in this array. Child plans must be created prior to their use here. Input arrays should be passed in the following format: child_plans[]. New parameter - eligible_child_plans has been added with more fields. This parameter would be deprecate soon.
  eligible_child_plans array   If the Plan has child plans, they can be passed in this array. Child plans must be created prior to their use here.
  brd_arrow.gifplan_no string 12 Aria generated unique of the plan
  OR      
  brd_arrow.gifclient_plan_id string   Client defined unique id for the plan
  brd_arrow.gifis_mandatory int   Determines if this child plan must be purchased along with the parent plan.   Allowable Values
  brd_arrow.gifinclude_default int   Determines if this child plan should be added to the purchase plan list in the UI.   Allowable Values
  brd_arrow.gifmin_units int 2 Determines the minimum number of units that must be purchased.
  brd_arrow.gifmax_units int 2 Determines the maximum number of units that can be purchased.
  brd_arrow.gifenforcement_level int 1 Determines the level at which the minimum and maximum values are enforced   Allowable Values
  notification_template_group_no string   This field is used to associate an existing notification template group to the plan.
  credit_note_template_no string   This field is used to associate an existing credit note template to the plan.
  credit_memo_template_no int   This field is used to associate an existing credit memo template to the plan.
  rebill_template_no int   This field is used to associate an existing rebill template to the plan.
  surcharge_no int array 12 Specifies the surcharge to associate with this plan. REST input arrays should be passed in the following format: surcharge_no[0]=1002&surcharge_no[1]=1003
  client_surcharge_id string array 100 Specifies the client defined id for surcharge to associate with this plan.REST input arrays should be passed in the following format: client_surcharge_id[]=1002&client_surcharge_id[]=1003
  proration_invoice_timing_cd string 1 Determines whether to create a separate invoice for prorated charges immediately, or defer to the next anniversary date.   Allowable Values
  plan_instance_status_cd int 2 Specifies the status of an account when the plan is assigned to a plan instance.   Allowable Values
  assign_field_categories array   An array of either field_category_no OR field_category_name. field_category_name will take precedence if both the values are passed
  brd_arrow.giffield_category_no int 100 This field is used as Primary id for field category number
  OR      
  brd_arrow.giffield_category_name string 100 This field is used as client defined ID
  brd_arrow.giffield_category_directive int 1 A directive that indicates the action to be taken   Allowable Values
  contract_rollover_plan_no int 100 Pre-defined plan to be used as the rollover plan at the completion of the contract
  OR      
  contract_rollover_client_plan_id string 100 Client-defined id of the pre-defined plan to be used as the rollover plan at the completion of a contract
  contract_rollover_rate_sched array    
  brd_arrow.gifcurrent_rate_sched_no int 100 Current rate schedule for which the rollover rate schedule is being defined
  OR      
  brd_arrow.gifcurrent_client_rate_sched_id string 100 Client-defined id of the current rate schedule for which the rollover rate schedule is being defined
  brd_arrow.gifrollover_rate_sched_no int 100 Pre-defined rate schedule to be used as the rollover rate schedule at the completion of the contract
  OR      
  brd_arrow.gifrollover_client_rate_sched_id string 100 Client-defined id of the pre-defined rate schedule to be used as the rollover rate schedule at the completion of the contract
  nso_incl_list_scope int 1 Scope of additional NSO as part of inclusion list   Allowable Values
  nso_incl_list_array int array 37 Specifies the Inventory item number. Mandatory inside array for nso_incl_list_scope is 3 or 4.
  nso_group_array array   Non-Subscription Offerings that are part of NSO group and is bundled with the plan.
  brd_arrow.gifitem_no int 100 Specifies the Inventory item number for adding into NSO group.
  brd_arrow.gifnso_group_price_override array    
  brd_arrow.gifrate_schedule_no int 100 The internal Id of the rate schedule for which the NSO price is being defined.
  OR      
  brd_arrow.gifclient_rate_schedule_id string 100 Client-defined id of the current rate schedule for which the NSO price is being defined.
  brd_arrow.gifoverride_price string 100 Specifies the overridden price for Inventory item for currencies. If there is no override price defined for NSO then list price is considered during plan assignment.
  nso_group_min_qty string 100 Minimum NSO quantity needed per NSO group during plan purchase. This value should be null when NSO scope is Exact Plan Units.
  nso_group_max_qty string 100 Maximum NSO quantity needed for NSO group during plan purchase. This value should be null when NSO scope is Exact Plan Units or Up to Plan Units.
  nso_group_item_scope string 1 Scope of bundled NSO group during plan purchase. Mandatory if item_no is specified otherwise optional.   Allowable Values
  nso_items_array array   Non-Subscription Offerings that are bundled with the plan.
  brd_arrow.gifitem_no int 100 Specifies the Inventory Item number for adding into NSO bundle.
  brd_arrow.gifnso_item_min_qty string 100 Minimum NSO quantity needed during plan purchase. This value should be null when NSO scope is Match Plan Units.
  brd_arrow.gifnso_item_max_qty string 100 Maximum NSO quantity needed during plan purchase. This value should be null when NSO scope is Match Plan Units or Up to Plan Units.
  brd_arrow.gifitem_scope string 1 Scope of bundled NSO during plan purchase. Mandatory if item_no is specified otherwise optional.   Allowable Values
  brd_arrow.gifnso_items_price_override array    
  brd_arrow.gifrate_schedule_no int 100 The internal Id of the rate schedule for which the NSO price is being defined.
  OR      
  brd_arrow.gifclient_rate_schedule_id string 100 Client-defined id of the current rate schedule for which the NSO price is being defined.
  brd_arrow.gifoverride_price string 100 Specifies the overridden price for Inventory item for currencies. If there is no override price defined for NSO then list price is considered during plan assignment.

Output Arguments

Field Name Field Type Description
error_code long Aria-assigned error identifier. 0 indicates no error
error_msg string Textual description of any error that occurred. "OK" if there was no error.
plan_no int Plan Number
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.