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_no | string | 100 | Specifies Plan Number |
OR | ||||
client_plan_id | string | 100 | Client defined unique identifier | |
plan_name | string | 100 | Specifies Plan Name. For edit_directives 1 and 2 plan_name is mandatory | |
plan_description | string | 3000 | Specifies plan description | |
![]() | 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 | |
![]() | string array | 100 | 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 | |
plan_type | int | Specifies Plan Type. Valid values are [ 'Master Recurring Plan', 'Master Pre-paid Plan', 'Master Free Plan', 'Supplemental Recurring Plan', 'Supplemental Free Plan']. Allowable Values | ||
active | int | 1 | Specifies Plan Status.Valid values are "1" or "0" 1 - Active 0 - Inactive. Allowable Values | |
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. For edit_directives 1 and 2 billing_interval is mandatory | |
usage_billing_interval | string | 2 | 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 | |
currency | string | 3 | Specifies the currency code. For edit_directives 1 and 2 currency is mandatory | |
template_no | int | 8 | Specifies invoice template class associated with master plan | |
OR | ||||
client_email_template_id | string | 100 | Client defined unique identifier. | |
rollover_months | string | 2 | Specifies rollover months. Valid values are from 0 to 36 | |
rollover_plan_no | int | 100 | Rollover Plan number. Rollover information is required for Pre-paid plans | |
OR | ||||
rollover_client_plan_id | string | 100 | Client defined unique identifier | |
dunning_plan_no | int | 100 | Specifies dunning plan associated with this plan | |
OR | ||||
dunning_client_plan_id | string | 100 | Client defined unique identifier | |
initial_free_months | int | 2 | Specifies initial free month. Valid values are : 0 to 12. 0 indicates no free months | |
acct_status_cd | int | 2 | 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 | 2 | 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 | 2 | Specifies the status the account will be in after its initial status. Valid values are ( 1 -> Active, 99->Permanent, -1 -> suspened, -3 -> terminated) | |
allow_child_accts | int | 3 | Specifies whether a plan can have child accounts or not. Valid values are "1" or "0" 1 - Yes 0 - No. The parameter has been depreciated. Value will be overrided to 1 | |
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.Apply cancellation is set when the plan is created and cannot be modified except for the min terms(months) 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 | int | Specifies when to apply min fee. Valid values are 0 which means 'All Invoices' and 1 which means 'After first invoice'. Allowable Values | ||
schedule | array | For edit_directives 1 schedule is mandatory | ||
![]() | int | 20 | Specifies the schedule number whose details is going to be edited. This can be nullable for new services.REST input arrays should passed in the following format: schedule[0][schedule_no]=1212121&schedule[1][schedule_no]=4234232 etc where schedule[0] specifies first schedule and schedule[1] specifies the second schedule and so on | |
OR | ||||
![]() | string | 100 | Client defined unique id | |
![]() | ![]() | 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. |
![]() | ![]() | string | 100 | 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 |
![]() | ![]() | int | 1 | Specifies which currency should be the default as the user can add the same currency multiple times. Accepted values are 1(default) and 0 |
![]() | string | 10 | Date from which the rate schedule will be available for the assignment. The date format must be yyyy-mm-dd | |
![]() | string | 10 | Date after which the rate schedule will not be available for the assignment. The date format must be yyyy-mm-dd | |
![]() | boolean | 1 | Indicator whether future rates should be supported or not | |
![]() | string | 10 | Date after which the future rates should be assigned. The date format must be yyyy-mm-dd | |
![]() | long | 100 | Aria internal id of follow-up default rate schedule | |
OR | ||||
![]() | 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 | For edit_directives 1 service is mandatory | ||
![]() | 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 | ||||
![]() | string | 100 | Client defined unique id | |
![]() | 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 | |
![]() | ![]() | string | Specifies the service type. Valid values : 'Activation', 'Recurring', 'Cancellation', 'Minimum Fee' and 'Usage-Based' REST input arrays should passed in the following format: service[0][service_type]=Recurring&service[1][service_type]=... Allowable Values | |
![]() | 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 | |
![]() | 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 | |
![]() | 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 | |
![]() | 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& | |
![]() | string | 20 | Commodity Code | |
![]() | string | Specifies the rate type of the service.valid values are: 'Flat Rate' and 'Tiered Pricing'.REST input arrays should be passed in the following format: service[0][rate_type]=Flat Rate&service[1][rate_type]=... Allowable Values | ||
![]() | string | Specifies the pricing rule. Valid values are: 'Standard', 'Volume Discount' and 'Flat Rate Per Tier'.REST input arrays should be passed in the following format:service[0][pricing_rule]=Standard&... Allowable Values | ||
![]() | int | Specifies the high water indicator. Valid values: 0 and 1.It is mandatory for Usage-Based services.REST input arrays should be passed in the following format: service[0][high_water]=1&service[1][high_water]=0 Allowable Values | ||
![]() | int | 3 | Specifies the two advanced billing options. This is only given for Usage-Based services only. Valid values: '1' => pool items, '2' =>usage tier multiplier and '0' for none. If you do no provide this information it will default to none. REST input arrays should passed in the following format: service[0][billing_option]=1&service[1][billing_option]=2 | |
![]() | int | 9 | Specifies the pool threshold. This is mandatory only if you choose ervice[0][billing_option]=1. This is only given for Usage-Based services only. If you do not provide any value it will default to 0. REST input arrays should passed in the following format: service[0][threshold]=123&service[1][threshold]=42 | |
![]() | 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. | |
![]() | array | Threshold units at the usage type level | ||
![]() | string | Notice Destination type. Acceptable values are A, C. Parameter is case insensitive Allowable Values | ||
![]() | string | Notice Balance type. Acceptable values are Daily, MTD, PTD. Parameter is case insensitive Allowable Values | ||
![]() | array | |||
![]() | int | 9 | Threshold units | |
![]() | 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 | ||
![]() | array | Tier is required for edit_directives 1 for the provided services | ||
![]() | int | 10 | Tiered Pricing Rule that specifies from units.REST input arrays should be passed in the Following format: service[0][tier][0][from]=1&service[0][tier][1][from]=1 etc. where Index [tier][0] specifies the first tier and [tier][1] specifies the second tier and so on. | |
![]() | int | 10 | Tiered Pricing Rule that specifies to units.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. | |
![]() | 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][description]=Custom description&service[0][tier][1][description]=custom description etc. Index [tier][0] specifies the first tier and [tier][1] specifies the second tier and so on. | |
![]() | array | |||
![]() | ![]() | 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. |
![]() | 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. | |
![]() | 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. | |
![]() | 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. | |
![]() | 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 | |
![]() | int | 1 | Indicates if the service is “Fulfillment Based” or not. Allowable Values | |
![]() | int | 1 | Indicates whether or not this usage-based service is rated on a daily basis. Allowable Values | |
resource | array | |||
![]() | 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. | ||
![]() | 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&... | |
![]() | 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&... | ||
![]() | 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&... | |
![]() | 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&... | |
![]() | 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 | ||
![]() | 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&... | |
![]() | 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 | 100 | Specifies one of the recurring service for the plan to which the resource is being applied | |
![]() | 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&... | |
![]() | 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&... | |
![]() | 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 | ||
![]() | int | 100 | the field no | |
OR | ||||
![]() | string | 100 | the field name | |
![]() | string array | the field value | ||
![]() | 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. | ||
![]() | 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 | |
![]() | 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 | |
edit_directives | int | A directive that indicates the action to be taken. This new parameter applies to the child_plans, parent_plans, exclusion_plans, plan_group, schedule, service, template_no, rollover_plan_no, dunning_plan_no, notification_template_group_no, supplemental_obj_field in the API Allowable Values |
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 |