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

 

Home > 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
client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
auth_key string 32 Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.
plan_name string 100 Specifies Plan Name
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
currency string 3 Specifies the currency code of plan
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.
active int 1 Specifies if inventory item is active or inactive. Valid values are: 0 - Inactive and 1 - Active   Allowable Values
schedule array
schedule_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.
currency_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
client_rate_schedule_id string 100 Client defined unique id
is_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.
available_from_dt string 10 Date from which the rate schedule will be available for the assignment. The date format must be yyyy-mm-dd
available_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
future_rate boolean 1 Indicator whether future rates should be supported or not
future_change_dt string 10 Date after which the future rates should be assigned. The date format must be yyyy-mm-dd
followup_rs_no long 100 Aria internal id of follow-up default rate schedule
OR
client_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.
service array
service_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
client_service_id string 100 Client defined unique id
name 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
service_type string Specifies Service types. Valid values are: "Usage Based", "Recurring", "Activation"   Allowable Values
gl_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
taxable_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
tax_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
usage_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&
commodity_cd string 20 Commodity Code
rate_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
pricing_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
high_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
tax_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.
usage_threshold array Threshold units at the usage type level
notice_dest_type string Notice Destination type. Acceptable values are A, C. Parameter is case insensitive   Allowable Values
notice_balance_type string Notice Balance type. Acceptable values are Daily, MTD, PTD. Parameter is case insensitive   Allowable Values
notifications array
units int 9 Threshold units
values 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
tier array
from 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.
to 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.
description 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.
schedule array
amount 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.
from 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.
to 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.
description 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.
future_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
fulfillment_based_ind int 1 Indicates if the service is “Fulfillment Based” or not.   Allowable Values
apply_usage_rates_daily int 1 Indicates whether or not this usage-based service is rated on a daily basis.   Allowable Values
plan_description string 3000 Specifies plan description
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
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
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
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
resource_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.
resource_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&...
resource_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&...
flat_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&...
resource_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&...
expire_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
additional_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&...
reset_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. This field is required only if the associated product fields are marked as required
field_no int 100 the field no
OR
field_name string 100 the field name
field_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[]
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.
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

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

You must to post a comment.
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.