Aria-assigned unique identifier indicating the Aria client providing service to this account.

Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.

Specifies Plan Name. Translatable.

Specifies plan description. Translatable.

Client defined unique identifier

Plan Group Number.REST input arrays should be passed in the following format: plan_group[]=2&plan_group[]=3&plan_group[]=4

Alternative field: plan_group_id

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

Alternative field: plan_group

Specifies Plan Type. Valid values are [ 'Master Recurring Plan', 'Master Pre-paid Plan', 'Master Free Plan', 'Supplemental Recurring Plan', 'Supplemental Free Plan']

Specifies the currency code of plan

Specifies if inventory item is active or inactive. Valid values are: 0 - Inactive and 1 - Active

Duration of the plan rollover period (used in conjunction with rollover_plan_uom_cd).

Units associated with the duration of the plan rollover period (used in conjunction with rollover_plan_duration).

Rollover Plan number

Alternative field: rollover_client_plan_id

Client defined unique identifier

Alternative field: rollover_plan_no

Duration of the initial free period (used in conjunction with init_free_period_uom_cd).

Units associated with the duration of the initial free period (used in conjunction with init_free_period_duration).

Default status used when master plan is initially assigned on an account.

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).

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).

Status used for the master plan instance at the completion of the plan status rollover period.

Specifies dunning plan associated with this plan

Alternative field: dunning_client_plan_id

Client defined unique identifier

Alternative field: dunning_plan_no

Specifies invoice template class associated with master plan

Alternative field: client_email_template_id

Client defined unique identifier.

Alternative field: template_no

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

Specifies the minimum term months for cancellation service

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.

Specifies when to apply min fee. Valid values are 0 which means 'All Invoices' and 1 which means 'After first invoice'.

The schedule associated with this method.

See fields below

The service associated with this method.

See fields below

The resource associated with this method.

See fields below

Specifies one of the recurring service for the plan to which the resource is being applied

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&...

Alternative field: parent_client_plan_ids

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&...

Alternative field: parent_plans

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&...

Specifies the supplemental object fields to be added for this usage type

See fields below

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.

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.

If the Plan has child plans, they can be passed in this array. Child plans must be created prior to their use here.

See fields below

This field is used to associate an existing notification template group to the plan.

This field is used to associate an existing credit note template to the plan.

This field is used to associate an existing credit memo template to the plan.

This field is used to associate an existing rebill template to the plan.

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 nullable: true

Alternative field: client_surcharge_id

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

Alternative field: surcharge_no

Indicates if the plan is configured for Advanced Usage Pricing

Determines whether to create a separate invoice for prorated charges immediately, or defer to the next anniversary date.

Default status used when master plan is initially assigned on an account.

An array of either field_category_no OR field_category_name. field_category_name will take precedence if both the values are passed

See fields below

Pre-defined plan to be used as the rollover plan at the completion of the contract

Alternative field: contract_rollover_client_plan_id

Client-defined id of the pre-defined plan to be used as the rollover plan at the completion of a contract

Alternative field: contract_rollover_plan_no

The contract_rollover_rate_sched associated with this method.

See fields below

Scope of additional NSO as part of inclusion list

Specifies the Inventory item number. Mandatory inside array for nso_incl_list_scope is 3 or 4.

Non-Subscription Offerings that are part of NSO group and is bundled with the plan.

See fields below

Minimum NSO quantity needed per NSO group during plan purchase. This value should be null when NSO scope is Exact Plan Units.

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.

Scope of bundled NSO group during plan purchase. Mandatory if item_no is specified otherwise optional.

Non-Subscription Offerings that are bundled with the plan.

See fields below

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.

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 defined unique id

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.

If a null/no value is provided then recurring_billing_interval should default to 1.

If a null/no value is provided then recurring_billing_period_type should default to 3, i.e. monthly period type. Recurring Billing Period Type [ can be either of 1, 2, 3 ] 1 – Daily, 2 – Weekly, 3 - Monthly

If null/no value is provided then usage_billing_interval should default to 1.

If a null/no value is provided then usage_billing_period_type should default to 3, i.e. monthly period type. Usage Billing Period Type [ can be either of 1, 2, 3 ] 1 – Daily, 2 – Weekly, 3 - Monthly

Date from which the rate schedule will be available for the assignment. The date format must be yyyy-mm-dd

Date after which the rate schedule will not be available for the assignment. The date format must be yyyy-mm-dd

Indicator whether future rates should be supported or not

Date after which the future rates should be assigned. The date format must be yyyy-mm-dd

Aria internal id of follow-up default rate schedule

Alternative field: client_followup_rs_id

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.

Alternative field: followup_rs_no

Notice Destination type. Acceptable values are S, C. Parameter is case insensitive.

Notice Balance type. Acceptable values are MTD, PTD. Parameter is case insensitive

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.

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.

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.

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.

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

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.

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.

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.

The schedule associated with this method.

See fields below

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

Alternative field: client_service_id

Client defined unique id

Alternative field: service_no

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.

Specifies Service types. Valid values are: "Usage Based", "Recurring", "Activation"

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

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

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

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 Code

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]=...

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&...

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&...

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.

This attribute is not in use. It is just a placeholder.

This attribute is not in use. It is just a placeholder.

Threshold units at the usage type level

See fields below

The tier associated with this method.

See fields below

Indicates if the service is “Fulfillment Based” or not.

Rating Time Indicator governs the time when usage is rated: during invoicing process or during usage loading to the platform.

Indicates whether the usage rating to be done at individual record level or aggregated records level.

Indicates whether the usage taxation to be done at individual record level or aggregated records level.

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.

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&...

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&...

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&...

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&...

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&...

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&...

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&...

the field no

Alternative field: field_name

the field name

Alternative field: field_no

the field value

Aria generated unique of the plan

Alternative field: client_plan_id

Client defined unique id for the plan

Alternative field: plan_no

Determines if this child plan must be purchased along with the parent plan.

Determines if this child plan should be added to the purchase plan list in the UI.

Determines the minimum number of units that must be purchased.

Determines the maximum number of units that can be purchased.

Determines the level at which the minimum and maximum values are enforced

This field is used as Primary id for field category number

Alternative field: field_category_name

This field is used as client defined ID

Alternative field: field_category_no

Specifies the field category directive. 1 to add and 2 to remove an field category

Current rate schedule for which the rollover rate schedule is being defined

Alternative field: current_client_rate_sched_id

Client-defined id of the current rate schedule for which the rollover rate schedule is being defined

Alternative field: current_rate_sched_no

Pre-defined rate schedule to be used as the rollover rate schedule at the completion of the contract

Alternative field: rollover_client_rate_sched_id

Client-defined id of the pre-defined rate schedule to be used as the rollover rate schedule at the completion of the contract

Alternative field: rollover_rate_sched_no

The internal Id of the plan rate schedule for which the NSO price is being defined.

Alternative field: client_rate_schedule_id

Client-defined id of the plan rate schedule for which the NSO price is being defined.

Alternative field: rate_schedule_no

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.

Aria-assigned unique identifier for the rate schedule to be used as the bundle price for the NSO when purchased with this plan.

Alternative field: bundle_client_nso_rate_schedule_id

Client-defined unique identifier for the rate schedule to be used as the bundle price for the NSO when purchased with this plan. If neither is specified, the default rate schedule for currency matching that of the account will be used.

Alternative field: bundle_nso_rate_schedule_no

Specifies the Inventory item number for adding into NSO group.

The nso_group_price_override associated with this method.

See fields below

The internal Id of the plan rate schedule for which the NSO price is being defined.

Alternative field: client_rate_schedule_id

Client-defined id of the plan rate schedule for which the NSO price is being defined.

Alternative field: rate_schedule_no

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.

Aria-assigned unique identifier for the rate schedule to be used as the bundle price for the NSO when purchased with this plan.

Alternative field: bundle_client_nso_rate_schedule_id

Client-defined unique identifier for the rate schedule to be used as the bundle price for the NSO when purchased with this plan. If neither is specified, the default rate schedule for currency matching that of the account will be used.

Alternative field: bundle_nso_rate_schedule_no

Specifies the Inventory Item number for adding into NSO bundle.

Minimum NSO quantity needed during plan purchase. This value should be null when NSO scope is Match Plan Units.

Maximum NSO quantity needed during plan purchase. This value should be null when NSO scope is Match Plan Units or Up to Plan Units.

Scope of bundled NSO during plan purchase. Mandatory if item_no is specified otherwise optional.

The nso_items_price_override associated with this method.

See fields below

Aria-assigned error identifier. 0 indicates no error

Textual description of any error that occurred. "OK" if there was no error.

Plan Number