error_code |
long |
Aria-assigned error identifier. 0 indicates no error. |
error_msg |
string |
Description of any error that occurred. "OK" if there was no error. |
all_client_plan_dtls |
hash |
A multidimensional array containing all client plans. |
plan_no |
long |
Aria-assigned unique plan identifier |
plan_name |
string |
Plan Name |
plan_desc |
string |
Text description of this plan |
supp_plan_ind |
long |
Indicates whether or not this plan is a supplemental plan.
Allowable values for supp_plan_ind:
Values |
Description |
0 |
Master Plan |
1 |
Supplemental Plan |
|
billing_ind |
long |
Indicates whether or not this plan is billable. This applies to Master Plans only. Supplemental plans inherit this property from their associated Master Plans.
Allowable values for billing_ind:
Values |
Description |
0 |
Plan is not billable. |
1 |
Plan is billable. |
|
display_ind |
long |
Indicates whether or not the plan is marked as "displayable". 0 means not displayable. 1 means displayable.
Allowable values for display_ind:
Values |
Description |
0 |
Plan is not displayable. |
1 |
Plan is displayable. |
|
rollover_months |
long |
Number of months in which the account will change from the current plan to the pre-defined rollover plan. |
rollover_plan_no |
long |
Pre-defined plan to which the account will change based on the defined rollover_months value; the rollover record is created when an account is placed on a plan with a defined rollover plan. |
early_cancel_fee |
double |
Fee charged for early cancellations. |
early_cancel_min_months |
long |
Number of months during which early cancellation fees would apply on plan cancellation. |
suspension_period |
long |
Pre-defined period in days in which an account will degrade to Suspended status (-1) if action is not taken such as a plan or status change. |
new_acct_status |
long |
The status code to assert for the new account.
Allowable values for new_acct_status:
Values |
Description |
0 |
INACTIVE |
1 |
ACTIVE |
2 |
CANCELLATION PENDING |
3 |
TERMINATION PENDING |
10 |
ACTIVE DUNNING PENDING |
11 |
ACTIVE DUNNING 1 |
12 |
ACTIVE DUNNING 1 |
13 |
ACTIVE DUNNING 3 |
14 |
ACTIVE DUNNING 4 |
15 |
ACTIVE DUNNING 5 |
16 |
ACTIVE DUNNING 6 |
17 |
ACTIVE DUNNING 7 |
18 |
ACTIVE DUNNING 8 |
21 |
REINSTATED FORWARD BILL |
22 |
REINSTATED BACK BILL |
31 |
INSTALLATION PENDING |
32 |
REGISTERED PENDING ACTIVATION |
41 |
ACTIVE TRIAL |
51 |
TEMPORARY SERVICE BAN |
61 |
ACTIVE NON-BILLABLE |
99 |
PERMANENT |
-1 |
SUSPENDED |
-2 |
CANCELLED |
-3 |
TERMINATED |
-4 |
CONTRACT EXPIRED |
-11 |
SUSPENDED DUNNING 1 |
-12 |
SUSPENDED DUNNING 2 |
-13 |
SUSPENDED DUNNING 3 |
-14 |
SUSPENDED DUNNING 4 |
-15 |
SUSPENDED DUNNING 5 |
-99 |
ARCHIVED |
|
rollover_acct_status |
long |
Default status for new accounts created on this plan.
Allowable values for rollover_acct_status:
Values |
Description |
0 |
INACTIVE |
1 |
ACTIVE |
2 |
CANCELLATION PENDING |
3 |
TERMINATION PENDING |
10 |
ACTIVE DUNNING PENDING |
11 |
ACTIVE DUNNING 1 |
12 |
ACTIVE DUNNING 1 |
13 |
ACTIVE DUNNING 3 |
14 |
ACTIVE DUNNING 4 |
15 |
ACTIVE DUNNING 5 |
16 |
ACTIVE DUNNING 6 |
17 |
ACTIVE DUNNING 7 |
18 |
ACTIVE DUNNING 8 |
21 |
REINSTATED FORWARD BILL |
22 |
REINSTATED BACK BILL |
31 |
INSTALLATION PENDING |
32 |
REGISTERED PENDING ACTIVATION |
41 |
ACTIVE TRIAL |
51 |
TEMPORARY SERVICE BAN |
61 |
ACTIVE NON-BILLABLE |
99 |
PERMANENT |
-1 |
SUSPENDED |
-2 |
CANCELLED |
-3 |
TERMINATED |
-4 |
CONTRACT EXPIRED |
-11 |
SUSPENDED DUNNING 1 |
-12 |
SUSPENDED DUNNING 2 |
-13 |
SUSPENDED DUNNING 3 |
-14 |
SUSPENDED DUNNING 4 |
-15 |
SUSPENDED DUNNING 5 |
-99 |
ARCHIVED |
|
rollover_acct_status_days |
long |
Number of days in which an account will change from the initial status code to the pre-defined rollover status code. |
init_free_months |
long |
Initial free months. |
plan_2_assign_on_susp |
long |
Plan to assign when an account on this plan is suspended. |
default_notify_method |
long |
Default notification method given to an account that is assigned to this plan.
Allowable values for default_notify_method:
Values |
Description |
0 |
None |
1 |
HTML Email |
2 |
Text Email |
3 |
Text Email w/link to HTML |
4 |
Data export |
5 |
Printable (no Email) w/Surcharge |
6 |
Printable & Text Email |
7 |
Printable & HTML Email w/Surcharge |
8 |
Printable (no Email) |
9 |
PDF (Printing required, no Email) |
10 |
PDF (delivered by Email) |
11 |
PDF (Printing req & Email)w/surcharge |
12 |
PDF (Printing req, no Email)w/surcharge |
13 |
XML Master File |
14 |
PDF Master File |
|
prepaid_ind |
long |
Indicates whether or not this plan is prepaid
Allowable values for prepaid_ind:
Values |
Description |
0 |
0 |
1 |
1 |
|
currency_cd |
string |
The 3-character ISO-compliant currency code in lowercase for monetary values used in the context of this API method. |
client_plan_id |
string |
Client assigned unique plan identifier |
client_rollover_plan_id |
string |
Pre-defined client rollover plan ID to which the account will change based on the defined rollover_months value; the rollover record is created when an account is placed on a plan with a defined client rollover plan ID. |
proration_invoice_timing_cd |
string |
Indicates whether to defer the pro-rated charges to the next anniversary date or to create a seperate invoice immediately.
Allowable values for proration_invoice_timing_cd:
Values |
Description |
I |
Indicates to generate the invoice immediately for the pro-rated charges. |
A |
Indicates to generate the invoice to the next anniversary date for the pro-rated charges. |
|
rollover_plan_duration |
string |
Duration of the plan rollover period (used in conjunction with rollover_plan_uom_cd). |
rollover_plan_uom_cd |
long |
Units associated with the duration of the plan rollover period (used in conjunction with rollover_plan_duration).
Allowable values for rollover_plan_uom_cd:
Values |
Description |
1 |
Day |
2 |
Week |
3 |
Month |
4 |
Quarter |
5 |
Year |
|
init_free_period_duration |
long |
Duration of the initial free period (used in conjunction with init_free_period_uom_cd). |
init_free_period_uom_cd |
string |
Units associated with the duration of the initial free period (used in conjunction with init_free_period_duration).
Allowable values for init_free_period_uom_cd:
Values |
Description |
1 |
Day |
2 |
Week |
3 |
Month |
4 |
Quarter |
5 |
Year |
|
initial_plan_status_cd |
long |
Default status used when master plan is initially assigned on an account.
Allowable values for initial_plan_status_cd:
Values |
Description |
1 |
ACTIVE |
41 |
ACTIVE TRIAL |
61 |
ACTIVE NON-BILLABLE |
|
rollover_plan_status_duration |
long |
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 |
long |
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 for rollover_plan_status_uom_cd:
Values |
Description |
1 |
Day |
2 |
Week |
3 |
Month |
4 |
Quarter |
5 |
Year |
|
rollover_plan_status_cd |
long |
Status used for the master plan instance at the completion of the plan status rollover period.
Allowable values for rollover_plan_status_cd:
Values |
Description |
1 |
ACTIVE |
41 |
ACTIVE TRIAL |
61 |
ACTIVE NON-BILLABLE |
|
nso_incl_list_scope |
long |
Scope of additional NSO as part of inclusion list.
Allowable values for nso_incl_list_scope:
Values |
Description |
0 |
Indicates to inclusion type All non-restricted inventory items. |
1 |
Indicates to inclusion type Existing bundled and non-restricted inventory items. |
2 |
Indicates to inclusion type Existing bundled inventory items only. |
3 |
Indicates to inclusion type Selected and non-restricted inventory items. |
4 |
Indicates to inclusion type Selected specific inventory items. |
|
plan_services |
hash |
A multidimensional array of Services for this plan |
service_no |
long |
The services for this plan |
service_desc |
string |
Description of this service |
is_recurring_ind |
long |
Indicates whether or not this service is a recurring service
Allowable values for is_recurring_ind:
Values |
Description |
0 |
Service is not recurring-based. |
1 |
Service is recurring-based. |
|
is_usage_based_ind |
long |
Indicates whether or not this service is a usage-based service
Allowable values for is_usage_based_ind:
Values |
Description |
0 |
Service is not usage-based. |
1 |
Service is usage-based. |
|
usage_type |
long |
The usage type supported by this usage based service |
taxable_ind |
long |
Indicates whether or not this service is taxable
Allowable values for taxable_ind:
Values |
Description |
0 |
Service is not taxable. |
1 |
Service is taxable. |
|
is_tax_ind |
long |
Indicates whether or not this service is a tax-based service
Allowable values for is_tax_ind:
Values |
Description |
0 |
Service is not a tax-based service. |
1 |
Service is a tax-based service. |
|
is_arrears_ind |
long |
Indicates whether or not this service is an arrears-based service
Allowable values for is_arrears_ind:
Values |
Description |
0 |
Service is not arrears-based. |
1 |
Service is arrears-based. |
|
is_setup_ind |
long |
Indicates whether or not this service is a setup-based service
Allowable values for is_setup_ind:
Values |
Description |
0 |
Service is not setup-based. |
1 |
Service is setup-based. |
|
is_misc_ind |
long |
Indicates whether or not this service is a miscellaneous service
Allowable values for is_misc_ind:
Values |
Description |
0 |
Service is not miscellaneous. |
1 |
Service is miscellaneous. |
|
is_donation_ind |
long |
Indicates whether or not this service is a donation-based service
Allowable values for is_donation_ind:
Values |
Description |
0 |
Service is not donation-based. |
1 |
Service is donation-based. |
|
is_order_based_ind
|
long |
Indicates whether or not this service is an order-based service
Allowable values for is_order_based_ind:
Values |
Description |
0 |
Service is not order-based. |
1 |
Service is order-based. |
|
is_cancellation_ind |
long |
Indicates whether or not this service is a cancellation- based service
Allowable values for is_cancellation_ind:
Values |
Description |
0 |
Service is not cancellation-based. |
1 |
Service is cancellation-based. |
|
coa_id |
string |
Chart of accounts ID |
ledger_code |
string |
This field is deprecated in favor of coa_id |
client_coa_code |
string |
The client-defined override for coa_id |
display_ind |
long |
Indicates if this service is displayable or not
Allowable values for display_ind:
Values |
Description |
0 |
Service is not displayable. |
1 |
Service is displayable. |
|
tiered_pricing_rule |
long |
The Tiered Pricing Rule
Allowable values for tiered_pricing_rule:
Values |
Description |
1 |
Standard |
2 |
Volume Discount |
3 |
Flat Rate Per Tier |
|
is_min_fee_ind |
long |
Indicates whether or not this service is a minimum fee.
Allowable values for is_min_fee_ind:
Values |
Description |
0 |
Service is not a minimum fee. |
1 |
Service is a minimum fee. |
|
client_service_id |
string |
The client-defined Service ID for this plan. |
usage_type_cd |
string |
Denotes which usage type to record. |
all_service_supp_fields |
hash |
|
field_name |
string |
The machine-readable name of this field |
field_desc |
string |
The human-readable name of this field |
field_order_no |
long |
The sort order of this field |
field_value |
string |
The value stored in this field |
fulfillment_based_ind |
long |
Indicates if the service is Fulfillment Based or not. |
svc_location_no |
long |
The Aria-assigned unique identifier for the origin location for the service. |
client_svc_location_id |
string |
The client-defined location identifier for the origin location for the service. |
svc_location_name |
string |
The name of the origin location for the service. |
svc_location_company_name |
string |
Company name of the service location. |
svc_location_address1 |
string |
First address line of the service location. |
svc_location_address2 |
string |
Second address line of the service location. If you want to delete existing data in this field, leaving it blank, you must enter a '~' in this field. |
svc_location_address3 |
string |
Third address line of the service location. |
svc_location_city |
string |
City of the service location. |
svc_location_locality |
string |
Locality of the service location. |
svc_location_state_prov |
string |
State or Province of the service location. The official postal-service codes for all United States, Australia and Canada states, provinces, and territories. This field does not support states, provinces or territories from other countries. Use the locality field for other countries. |
svc_location_country |
string |
Country of the location contact. The ISO-compliant 2-character country code abbreviation in uppercase. |
svc_location_postal_cd |
string |
Postal/Zip code for the service location address. |
plan_service_rates |
hash |
Represents the rates for the default rate schedule for the default currency for the plan |
rate_seq_no |
long |
Sequential number in the rate schedule for determining tiers |
from_unit |
double |
Tiered Units (from) This value represents the start of a tiered range of values. |
to_unit |
double |
Tiered Units (to) This value represents the end of the range for a single tier of values. |
rate_per_unit |
double |
The cost per unit of this service over the time period the plan is billed for |
future_rate_per_unit |
double |
The future cost per unit of this service over the time period the plan is billed for |
monthly_fee |
double |
If the plan interval is more than one month, this field will rate per unit per month |
client_rate_schedule_id |
string |
Client assigned unique rate schedule number |
rate_tier_description |
string |
Rate Tier Description |
all_plan_service_rates |
hash |
All rates for all rate schedules and currencies for this plan |
schedule_no |
long |
Rate schedule number |
client_rate_schedule_id |
string |
Client assigned unique rate schedule number |
future_rate |
long |
Indicates whether future rates are captured or not.
Allowable values for future_rate:
Values |
Description |
0 |
false, i.e., no future rate. |
1 |
True, i.e., future rates are captured. |
|
null, i.e., no future rate. |
|
future_change_date |
string |
Future Change Date of the rates. |
followup_rs_no |
long |
Aria internal ID of follow-up default rate schedule |
client_followup_rs_id |
string |
Client-defined ID of followup rate schedule |
plan_service_rates |
hash |
Represents the rates for the default rate schedule for the default currency for the plan |
rate_seq_no |
long |
Sequential number in the rate schedule for determining tiers |
from_unit |
double |
Tiered Units (from) This value represents the start of a tiered range of values. |
to_unit |
double |
Tiered Units (to) This value represents the end of the range for a single tier of values. |
rate_per_unit |
double |
The cost per unit of this service over the time period the plan is billed for |
future_rate_per_unit |
double |
The future cost per unit of this service over the time period the plan is billed for |
monthly_fee |
double |
If the plan interval is more than one month, this field will rate per unit per month |
client_rate_schedule_id |
string |
Client assigned unique rate schedule number |
rate_tier_description |
string |
Rate Tier Description |
usage_type_name |
string |
The human-readable name of this usage type |
usage_type_desc |
string |
The long description of this usage type |
usage_type_code |
string |
Client-assigned identifier for the type of usage being recorded. |
usage_unit_label |
string |
The display-level description of the units this usage represents. |
apply_usage_rates_daily |
long |
Indicates whether or not this usage-based service is rated on a daily basis.
Allowable values for apply_usage_rates_daily:
Values |
Description |
0 |
usage shall be rated based on the entire billing period |
1 |
usage shall be rated based on one day periods individually. |
|
tax_inclusive_ind |
long |
Indicator that states whether a taxable service is tax-inclusive or tax-exclusive.
Allowable values for tax_inclusive_ind:
Values |
Description |
0 |
The service is tax-exclusive. |
1 |
The service is tax-inclusive. |
|
plan_rate_schedules_details |
hash |
An array of the rate schedules for the requested plan |
schedule_no |
long |
The ID of this rate schedule |
client_rate_schedule_id |
string |
Client assigned unique rate schedule number |
schedule_name |
string |
The name of this rate schedule |
schedule_currency |
string |
The currency this rate schedule is linked to |
recurring_billing_interval |
long |
Number of months between billing cycles for recurring |
usage_billing_interval |
long |
Number of months between billing cycles for usage |
recurring_billing_period_type |
long |
Period type for billing cycles for recurring.
Allowable values for recurring_billing_period_type:
Values |
Description |
1 |
Period type for recurring billing cycle is Daily. |
2 |
Period type for recurring billing cycle is Weekly. |
3 |
Period type for recurring billing cycle is Monthly. |
4 |
Period type for recurring billing cycle is Quarterly. |
5 |
Period type for recurring billing cycle is Yearly. |
|
usage_billing_period_type |
long |
Period type for billing cycles for usage.
Allowable values for usage_billing_period_type:
Values |
Description |
1 |
Period type for usage billing cycle is Daily. |
2 |
Period type for usage billing cycle is Weekly. |
3 |
Period type for usage billing cycle is Monthly. |
4 |
Period type for usage billing cycle is Quarterly. |
5 |
Period type for usage billing cycle is Yearly. |
|
default_ind |
long |
If true, this is the default rate schedule for the default currency
Allowable values for default_ind:
Values |
Description |
0 |
Rate schedule is not the default. |
1 |
Rate schedule is the default. |
|
default_ind_curr |
long |
If true, this is the default rate schedule for the specified currency
Allowable values for default_ind_curr:
Values |
Description |
0 |
Rate schedule is not default for specified currency. |
1 |
Rate schedule is default for specified currency. |
|
schedule_display_ind |
long |
Determines whether the rate schedule is displayable
Allowable values for schedule_display_ind:
Values |
Description |
0 |
Rate schedule is not displayable. |
1 |
Rate schedule is displayable. |
|
available_from_dt |
string |
Start date of rate schedule |
available_to_dt |
string |
End date of rate schedule |
followup_rs_no |
long |
Aria internal ID of follow-up default rate schedule |
client_followup_rs_id |
string |
Client-defined ID of followup rate schedule |
contract_rollover_plan_no |
long |
Pre-defined plan to be used as the rollover plan at the completion of the contract. |
contract_rollover_client_plan_id |
string |
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 |
hash |
|
contract_current_rate_sched_no |
long |
Current rate schedule for which the rollover rate schedule will be used at the completion of the contract |
contract_current_client_rate_sched_id |
string |
Client-defined ID of the current rate schedule for which the rollover rate schedule will be used at the completion of the contract |
contract_rollover_rate_sched_no |
long |
Pre-defined rate schedule to be used as the rollover rate schedule at the completion of the contract |
contract_rollover_client_rate_sched_id |
string |
Client-defined ID of the pre-defined rate schedule to be used as the rollover rate schedule at the completion of the contract |
plan_nso_incl_list |
hash |
Non-Subscription Offerings inclusion list that is in addition to NSOs that are bundled with the plan |
item_no |
long |
Inventory item number |
active_ind |
long |
Inventory item status.
Allowable values for active_ind:
Values |
Description |
0 |
Inventory item is not active. |
1 |
Inventory item is active. |
|
plan_groups |
hash |
A grouping of plans which can be used for plan assignment |
plan_group_no |
long |
The ID of this plan group |
plan_group_name |
string |
The name of this plan group |
plan_group_desc |
string |
The long description of this plan group |
plan_group_usage |
string |
Determines where the plan groups are made available
Allowable values for plan_group_usage:
Values |
Description |
C |
By CSRs only within AdminTools |
U |
Within your User Self Service applications only |
B |
For both CSR and USS |
|
selectable_ind |
long |
Whether or not this plan group is selectable
Allowable values for selectable_ind:
Values |
Description |
0 |
Plan group is not selectable. |
1 |
Plan group is selectable. |
|
client_plan_group_id |
string |
Client-defined ID for this plan group |
promotional_plan_sets |
hash |
A grouping of plans based on promo code |
promo_set_no |
long |
The ID of this promotional plan set |
promo_set_name |
string |
The name of this promotional plan set |
promo_set_desc |
string |
The long description of this promotional plan set |
promotions_for_set |
hash |
The promo codes associated with this group of plans |
promo_code |
string |
The promo code itself |
promo_code_desc |
string |
A long description of this promo code |
client_promo_set_id |
string |
Client-defined ID of this promotional plan set |
parent_plans |
hash |
The plans which are mapped as parents of this plan |
parent_plan_no |
long |
ID of the parent plan |
parent_plan_name |
string |
Name of the parent plan |
client_parent_plan_id |
string |
Client-defined unique parent Plan ID |
plan_supp_fields |
hash |
Supplemental object fields associated with this plan |
plan_supp_field_no |
long |
Supplemental object field ID |
plan_supp_field_name |
string |
Name of the supplemental field. This value is required if you want to assign supplemental fields. For example, if you have any accounts that are tax-exempt or international, you must set up corresponding account supplemental fields prior to your tax provider configuration. Create fields for the tax exemption number and for the VAT ID used by the tax provider. |
plan_supp_field_desc |
string |
Description of the supplemental object field |
plan_supp_field_value |
string |
The value in this supplemental field on the plan |
first_retrieval_level_ind |
string |
If true, this plan met the initial filtering criteria used to retrieve this list of plans. If false, this plan is a child plan (or other descendant) of a plan which met the initial criteria
Allowable values for first_retrieval_level_ind:
Values |
Description |
true |
This plan met the initial filtering criteria used to retrieve this list of plans. |
false |
This plan is a child plan (or other decendant) of a plan which met the initial criteria. |
|
child_plans |
hash |
The plans which are mapped as children of this plan |
plan_no |
long |
Aria generated unique ID of the plan. |
client_plan_id |
string |
Client-defined unique ID for the plan. |
is_mandatory |
long |
Determines if this child plan must be purchased along with the parent plan.
Allowable values for is_mandatory:
Values |
Description |
0 |
non-mandatory (default) |
1 |
mandatory |
|
is_default |
string |
Determines if this child plan must be added to the purchase plan list in the UI.
Allowable values for is_default:
Values |
Description |
0 |
this will not be mapped as default plan to the respective parent plan (default) |
1 |
this will be mapped as default plan to the respective parent plan |
|
min_units |
long |
Determines the minimum number of units that must be purchased. |
max_units |
string |
Determines the maximum number of units that can be purchased. |
enforcement_level |
string |
Determines the level at which the minimum and maximum values are enforced.
Allowable values for enforcement_level:
Values |
Description |
0 |
For each parent plan unit or Instance individually (default) |
1 |
In aggregate across all units and instances of this parent plan on the Account |
|
plan_nso_items |
hash |
Non-Subscription Offerings that are bundled with the plan. |
item_no |
long |
Inventory item number that is bundled with the plan |
active_ind |
long |
Inventory item status.
Allowable values for active_ind:
Values |
Description |
0 |
Inventory item is not active. |
1 |
Inventory item is active. |
|
min_qty |
string |
Minimum NSO quantity needed during plan purchase |
max_qty |
string |
Maximum NSO quantity needed during plan purchase |
item_scope |
long |
Scope of bundled NSO during plan purchase.
Allowable values for item_scope:
Values |
Description |
0 |
Up to Plan Units |
1 |
Match Plan Units |
2 |
Any Units |
|
plan_nso_price_override |
hash |
Overridden prices for NSO items. |
rate_schedule_no |
long |
The internal Id of the rate schedule (DEPRECATED; use list_rate_schedule_no) |
client_rate_schedule_id |
string |
Client assigned unique rate schedule number (DEPRECATED; use client_list_rate_schedule_id) |
currency_cd |
string |
Currency code for Inventory item. |
override_price |
string |
Overridden price for Inventory item for currencies. |
list_rate_schedule_no |
long |
Aria-assigned unique identifier for the rate schedule to be used as the list price for the NSO when purchased with this plan. |
client_list_rate_schedule_id |
string |
Client-defined unique identifier for the rate schedule to be used as the list price for the NSO when purchased with this plan. |
bundle_nso_rate_schedule_no |
string |
Aria-assigned unique identifier for the rate schedule to be used as the bundle price for the NSO when purchased with this plan. |
bundle_client_nso_rate_schedule_id |
string |
Client-defined unique identifier for the rate schedule to be used as the bundle price for the NSO when purchased with this plan. |
plan_nso_group |
hash |
Non-Subscription Offerings that are bundled with the plan as part of NSO group |
item_no |
long |
Inventory item number that is bundled with the plan |
active_ind |
long |
Inventory item status.
Allowable values for active_ind:
Values |
Description |
0 |
0 |
1 |
1 |
|
plan_nso_group_price_override |
hash |
Overridden prices for NSO items. |
rate_schedule_no |
long |
The internal Id of the rate schedule (DEPRECATED; use list_rate_schedule_no) |
client_rate_schedule_id |
string |
Client assigned unique rate schedule number (DEPRECATED; use client_list_rate_schedule_no) |
currency_cd |
string |
Currency code for Inventory item. |
override_price |
string |
Overridden price for Inventory item for currencies. |
bundle_nso_rate_schedule_no |
string |
Aria-assigned unique identifier for the rate schedule to be used as the bundle price for the NSO when purchased with this plan. |
bundle_client_nso_rate_schedule_id |
string |
Client-defined unique identifier for the rate schedule to be used as the bundle price for the NSO when purchased with this plan. |
nso_group_min_qty |
string |
Minimum NSO quantity needed during plan purchase for the NSO group. |
nso_group_max_qty |
string |
Maximum NSO quantity needed during plan purchase for the NSO group. |
nso_group_item_scope |
string |
Scope of bundled NSO group during plan purchase.
Allowable values for nso_group_item_scope:
Values |
Description |
0 |
Up to Plan Units |
1 |
Match Plan Units |
2 |
Any Units |
|
plan_translation_dtls |
hash |
|
plan_no |
long |
Aria-assigned unique plan identifier |
locale_name |
string |
Name of the locale. |
plan_name |
string |
The short name of this plan. |
plan_desc |
string |
The long description of this plan. |
locale_no |
long |
Aria-assigned unique identifier of the locale used for translations. This value must be unique across all Aria clients. |
plan_service_t |
hash |
|
service_no |
long |
The unique ID for the service this line represents. |
service_desc |
string |
The name of the service this line represents. |
all_service_supp_fields_t |
hash |
|
field_name |
string |
The machine-readable name of this field |
field_desc |
string |
The human-readable name of this field |
field_order_no |
long |
The sort order of this field |
field_value |
string |
The value stored in this field |
plan_service_rates_t |
hash |
Represents the rates for the default rate schedule for the default currency for the plan. |
rate_seq_no |
long |
Sequential number in the rate schedule for determining tiers |
rate_schedule_name |
string |
Rate Tier Description |
rate_tier_description |
string |
Rate Tier Description |
usage_type_name |
string |
The human-readable name of this usage type |
usage_type_desc |
string |
The long description of this usage type |
usage_unit_label |
string |
The display-level description of the units this usage represents. |
plan_supp_fields_t |
hash |
Supplemental object fields associated with this plan |
plan_supp_field_no |
long |
Supplemental object field ID |
plan_supp_field_name |
string |
Name of the supplemental field. This value is required if you want to assign supplemental fields. For example, if you have any accounts that are tax-exempt or international, you must set up corresponding account supplemental fields prior to your tax provider configuration. Create fields for the tax exemption number and for the VAT ID used by the tax provider. |
plan_supp_field_desc |
string |
Description of the supplemental object field |
plan_supp_field_value |
string |
The value in this supplemental field on the plan |