Home > Aria6 User Documentation > Aria6 admintools api > create_new_plan

create_new_plan

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
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 for plan_type

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
required-icon.png currency string 3 Specifies the currency code of plan
required-icon.png billing_interval string 2 Billing Interval [ can be either of 1, 3, 6 or 12 ) 1 - Monthly 3 - Quarterly 6 - Semi-Annually 12 - Annually. For custom the user can provide any number but not greater than 274,877,906,944 months.
required-icon.png active int 1 Specifies if inventory item is active or inactive. Valid values are: 0 - Inactive and 1 - Active

Allowable values for active

Values Description
0 Inactive
1 Active
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.
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.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
required-icon.png brd_arrow.gifservice_type string   Specifies Service types. Valid values are: "Usage Based", "Recurring", "Activation"

Allowable values for service_type

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
  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 for rate_type

Values Description
Flat Rate Applies Flat Rate type pricing to the rate schedule
Tiered Pricing Applies Tiered Pricing to the rate schedule
  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 for pricing_rule

Values Description
Standard Standard Pricing
Volume Discount Volume Discount Pricing
Flat Rate Per Tier Flat Rate Per Tier Pricing
  brd_arrow.gifhigh_water int   Specifies the high water indicator of the service if service_type = "Usage-Based". Valid values: 'Yes' and 'No'. Default value is "No". 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]=Yes&service[1][high_water]=No&...

Allowable values for high_water

Values Description
1 Enables high water indicator for the particular service
0 Doesn't enable high water indicator for the particular service
  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 A, C. Parameter is case insensitive.

Allowable values for notice_dest_type

Values Description
A Account level threshold
C Client level threshold
  brd_arrow.gifnotice_balance_type string   Notice Balance type. Acceptable values are Daily, MTD, PTD. Parameter is case insensitive.

Allowable values for notice_balance_type

Values Description
DTD Daily balance type
MTD Month-To-Date balance type
PTD Period-To-Date balance type
  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 for values

Values Description
1 1
2 2
3 3
4 4
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.
  brd_arrow.gifschedule array    
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.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.
  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 for fulfillment_based_ind

Values Description
0 Not a fulfillment based service
1 Fulfillment based service
  brd_arrow.gifapply_usage_rates_daily int 1 Indicates whether or not this usage-based service is rated on a daily basis.

Allowable values for apply_usage_rates_daily

Values Description
0 Doesn't apply rates daily for the particular service
1 Applies rates daily for the particular service
  plan_description string 3000 Specifies plan description
  client_plan_id string 100 Client defined unique identifier
  brd_arrow.gifplan_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
  brd_arrow.gifplan_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
  usage_billing_interval string   Usage billing Interval [ can be either of 1, 3, 6, 12 or custom ) 1 - Monthly 3 - Quarterly 6 - Semi-Annually 12 - Annually. For custom the user can provide any number but not greater than 274,877,906,944 months. Also the usage billing interval cannot be greater than the plan billing_interval
  rollover_months string 2 Specifies rollover months. Valid values are from 0 to 36
  rollover_plan_no int 100 Rollover Plan number
  OR      
  rollover_client_plan_id string 100 Client defined unique identifier
  initial_free_months int   Specifies initial free month. Valid values are : 0 to 12. 0 indicates no free months
  free_trial_type string   Specifies free trial type. Valid values are : days, months.

Allowable values for free_trial_type

Values Description
days days
months months
  free_trial_duration string   Specifies free trial Duration. Valid values are from 1 to 99.
  acct_status_cd int   Specifies the status of an account when the plan is assigned to a account. Valid values are ( 1- Active, 61 - Active non-billable, 41 - Active trial, 31- Installation pending, 99 - Permanent, 32- Registered pending activation )
  rollover_acct_status_days int   Specifies the number of days the newly created account will remain in its initial status. Valid value are 0 through 28. 0 indicates No New Account Status
  rollover_acct_status_cd int   Specifies the status the account will be in after its initial status. Valid values are ( 1 -> Active, 99->Permanent, -1 -> suspened, -3 -> terminated)
  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 for apply_cancellation

Values Description
Yes If set as Yes, minimum cancellation service can be added
No If set as No, minimum cancellation service cannot be added
  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 for apply_minimum_fee

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 string   Specifies when to apply min fee. Valid values are 0 which means 'All Invoices' and 1 which means 'After first invoice'.

Allowable values for how_to_apply_min_fee

Values Description
0 All Invoices
1 After first invoice
  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 for expire_on_paid_through

Values Description
0 No
1 Yes
  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 for reset_on_update

Values Description
0 No
1 Yes
  arc_service_no int   Specifies one of the recurring service for the plan to which the resource is being applied
  brd_arrow.gifparent_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&...
  brd_arrow.gifparent_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&...
  brd_arrow.gifexclusion_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. This field is required only if the associated product fields are marked as required
  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 for template_ind

Values Description
0 Doesn't create a plan as a template
1 Creates a plan as a template
  brd_arrow.gifchild_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[]
  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.
  brd_arrow.gifsurcharge_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
  brd_arrow.gifclient_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 for proration_invoice_timing_cd

Values Description
I Immediate
A Next anniversary date
 

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.
Powered by CXone Expert ®