Skip to main content
Aria Knowledge Central

get_client_plans_all_m

  1. Last updated
  2. Save as PDF

Summary

API Name get_client_plans_all_m
Class system_services_m
Update Version 38

Description

Returns a detailed list of all plans associated with a client. If you do not filter the call by acct_no, the information returned includes the services and rate schedules associated with the plans. If you filter the call by acct_no, or enter a plan_no or a client_plan_id that is a supplemental plan number, the information returned does not include any master plan service or rate schedule details.

Inputs

Name Type Length Required Description
client_no long 22 Yes

Aria-assigned unique identifier indicating the Aria client providing service to this account.
auth_key string 32 No

Aria-assigned unique key for authenticating the validity of the requestor. This key is passed with each method call.
plan_no long 22 No

Unique Aria-assigned plan number. Provide a value for this field to filter the list of plans returned.

Alternative field: client_plan_id
acct_no long 38 No

Unique Aria-assigned account number. Provide a value for this field to filter the list of plans returned.

Alternative field: client_acct_id
promo_code string 30 No

Provide a value for this field to filter the list of plans return. This code is provided during registration and generally provides access to a custom set of reduced-rate plans.
parent_plan_no long 22 No

Unique Aria-assigned plan number. Provide a value for this field to filter the list of plans returned.

Alternative field: client_parent_plan_id
Start of supp_field_names object
supp_field_names object   No  
Name Type Length Required Description
▶supp_field_names string   No

An array of client-defined product field names. Provide a value for this field to filter the list of plans returned.
End of supp_field_names object
Start of supp_field_values object
supp_field_values object   No  
Name Type Length Required Description
▶supp_field_values string   No

An array of client-defined product field values paired with the provided product field names above. Provide a value for this field to filter the list of plans returned.
End of supp_field_values object
include_all_rate_schedules string 5 No

If set to "true", will retrieve all of the rates and rate schedules associated with a particular plan. If left blank, will default to "false".

Allowed values:

Value Description
True  
False  
include_plan_hierarchy string 5 No

You can use this input parameter to specify whether to retrieve the child plans associated with the returned plans or with the plan_no or parent_plan_no that you specified. If you set the include_plan_hierarchy parameter to true , then all of the child plans down to the bottom level of your plan hierarchy will be returned.

Allowed values:

Value Description
True  
False  
client_plan_id string 100 No

Client-defined Plan ID for which to query available child plans

Alternative field: plan_no
client_parent_plan_id string 100 No

Client-defined unique parent Plan ID

Alternative field: parent_plan_no
retrieve_bundled_nso string 5 No

If set to "true", will retrieve all of the bundled inventory items associated with a particular plan. If left blank, will default to "false".

Allowed values:

Value Description
True  
False  
retrieve_included_nso string 5 No

If set to "true", will retrieve all of the inventory items associated with a particular plan. If left blank, will default to "false".

Allowed values:

Value Description
True  
False  
locale_no long 30 No

Aria-assigned unique identifier of the locale used for translations. This value must be unique across all Aria clients.

Alternative field: locale_name
locale_name string 100 No

Name of the locale.

Alternative field: locale_no
include_translations string 5 No

Setting this flag as True will fetch the translated fields in all the locales defined. If not passed it defaults to False.

Allowed values:

Value Description
True  
False  
client_acct_id string 50 No

Client-defined account identifier.

Alternative field: acct_no

Outputs

Name Type Length Required Description
error_code long   No

Aria-assigned error identifier. 0 indicates no error.
error_msg string   No

Description of any error that occurred. "OK" if there was no error.
Start of all_client_plan_dtls object
all_client_plan_dtls object   No

A multidimensional array containing all client plans.
Name Type Length Required Description
▶plan_no long 22 No

Aria-assigned unique plan identifier
▶plan_name string   No

Plan Name
▶plan_desc string   No

Text description of this plan
▶supp_plan_ind long   No

Indicates whether or not this plan is a supplemental plan.

Allowed values:

Value Description
0 Master Plan
1 Supplemental Plan
▶billing_ind long   No

Indicates whether or not this plan is billable. This applies to Master Plans only. Supplemental plans inherit this property from their associated Master Plans.

Allowed values:

Value Description
0 Plan is not billable.
1 Plan is billable.
▶display_ind long   No

Indicates whether or not the plan is marked as "displayable". 0 means not displayable. 1 means displayable.

Allowed values:

Value Description
0 Plan is not displayable.
1 Plan is displayable.
▶rollover_months long   No

Number of months in which the account will change from the current plan to the pre-defined rollover plan.
▶rollover_plan_no long   No

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   No

Fee charged for early cancellations.
▶early_cancel_min_months long   No

Number of months during which early cancellation fees would apply on plan cancellation.
▶suspension_period long   No

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   No

The status code to assert for the new account.

Allowed values:

Value 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   No

Default status for new accounts created on this plan.

Allowed values:

Value 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   No

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   No

Initial free months.
▶plan_2_assign_on_susp long   No

Plan to assign when an account on this plan is suspended.
▶default_notify_method long   No

Default notification method given to an account that is assigned to this plan.

Allowed values:

Value 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   No

Indicates whether or not this plan is prepaid

Allowed values:

Value Description
0  
1  
▶currency_cd string   No

The 3-character ISO-compliant currency code in lowercase for monetary values used in the context of this API method.
▶client_plan_id string 100 No

Client assigned unique plan identifier
▶client_rollover_plan_id string 100 No

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 2 No

Indicates whether to defer the pro-rated charges to the next anniversary date or to create a seperate invoice immediately.

Allowed values:

Value 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   No

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

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

Allowed values:

Value Description
1 Day
2 Week
3 Month
4 Quarter
5 Year
▶init_free_period_duration long   No

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

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

Allowed values:

Value Description
1 Day
2 Week
3 Month
4 Quarter
5 Year
▶initial_plan_status_cd long   No

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

Allowed values:

Value Description
1 ACTIVE
41 ACTIVE TRIAL
61 ACTIVE NON-BILLABLE
▶rollover_plan_status_duration long   No

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   No

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

Allowed values:

Value Description
1 Day
2 Week
3 Month
4 Quarter
5 Year
▶rollover_plan_status_cd long   No

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

Allowed values:

Value Description
1 ACTIVE
41 ACTIVE TRIAL
61 ACTIVE NON-BILLABLE
▶nso_incl_list_scope long 2 No

Scope of additional NSO as part of inclusion list.

Allowed values:

Value 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.
Start of plan_services object
▶plan_services object   No

A multidimensional array of Services for this plan
Name Type Length Required Description
▶▶service_no long 22 No

The services for this plan
▶▶service_desc string   No

Description of this service
▶▶is_recurring_ind long   No

Indicates whether or not this service is a recurring service

Allowed values:

Value Description
0 Service is not recurring-based.
1 Service is recurring-based.
▶▶is_usage_based_ind long   No

Indicates whether or not this service is a usage-based service

Allowed values:

Value Description
0 Service is not usage-based.
1 Service is usage-based.
▶▶usage_type long   No

The usage type supported by this usage based service
▶▶taxable_ind long   No

Indicates whether or not this service is taxable

Allowed values:

Value Description
0 Service is not taxable.
1 Service is taxable.
▶▶is_tax_ind long   No

Indicates whether or not this service is a tax-based service

Allowed values:

Value Description
0 Service is not a tax-based service.
1 Service is a tax-based service.
▶▶is_arrears_ind long   No

Indicates whether or not this service is an arrears-based service

Allowed values:

Value Description
0 Service is not arrears-based.
1 Service is arrears-based.
▶▶is_setup_ind long   No

Indicates whether or not this service is a setup-based service

Allowed values:

Value Description
0 Service is not setup-based.
1 Service is setup-based.
▶▶is_misc_ind long   No

Indicates whether or not this service is a miscellaneous service

Allowed values:

Value Description
0 Service is not miscellaneous.
1 Service is miscellaneous.
▶▶is_donation_ind long   No

Indicates whether or not this service is a donation-based service

Allowed values:

Value Description
0 Service is not donation-based.
1 Service is donation-based.
▶▶is_order_based_ind long   No

Indicates whether or not this service is an order-based service

Allowed values:

Value Description
0 Service is not order-based.
1 Service is order-based.
▶▶is_cancellation_ind long   No

Indicates whether or not this service is a cancellation- based service

Allowed values:

Value Description
0 Service is not cancellation-based.
1 Service is cancellation-based.
▶▶coa_id string   No

Chart of accounts ID
▶▶ledger_code string   No

This field is deprecated in favor of coa_id
▶▶client_coa_code string   No

The client-defined override for coa_id
▶▶display_ind long   No

Indicates if this service is displayable or not

Allowed values:

Value Description
0 Service is not displayable.
1 Service is displayable.
▶▶tiered_pricing_rule long   No

The Tiered Pricing Rule

Allowed values:

Value Description
1 Standard
2 Volume Discount
3 Flat Rate Per Tier
▶▶is_min_fee_ind long   No

Indicates whether or not this service is a minimum fee.

Allowed values:

Value Description
0 Service is not a minimum fee.
1 Service is a minimum fee.
▶▶client_service_id string 100 No

The client-defined Service ID for this plan.
▶▶usage_type_cd string 100 No

Denotes which usage type to record.
Start of all_service_supp_fields object
▶▶all_service_supp_fields object   No  
Name Type Length Required Description
▶▶▶field_name string   No

The machine-readable name of this field
▶▶▶field_desc string   No

The human-readable name of this field
▶▶▶field_order_no long   No

The sort order of this field
▶▶▶field_value string   No

The value stored in this field
End of all_service_supp_fields object
▶▶fulfillment_based_ind long 1 No

Indicates if the service is Fulfillment Based or not.
▶▶svc_location_no long 22 No

The Aria-assigned unique identifier for the origin location for the service.
▶▶client_svc_location_id string 100 No

The client-defined location identifier for the origin location for the service.
▶▶svc_location_name string   No

The name of the origin location for the service.
▶▶svc_location_company_name string   No

Company name of the service location.
▶▶svc_location_address1 string   No

First address line of the service location.
▶▶svc_location_address2 string   No

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   No

Third address line of the service location.
▶▶svc_location_city string   No

City of the service location.
▶▶svc_location_locality string   No

Locality of the service location.
▶▶svc_location_state_prov string   No

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   No

Country of the location contact. The ISO-compliant 2-character country code abbreviation in uppercase.
▶▶svc_location_postal_cd string   No

Postal/Zip code for the service location address.
Start of plan_service_rates object
▶▶plan_service_rates object   No

Represents the rates for the default rate schedule for the default currency for the plan
Name Type Length Required Description
▶▶▶rate_seq_no long   No

Sequential number in the rate schedule for dertermining tiers
▶▶▶from_unit double   No

Tiered Units (from) This value represents the start of a tiered range of values.
▶▶▶to_unit double   No

Tiered Units (to) This value represents the end of the range for a single tier of values.
▶▶▶rate_per_unit double   No

The cost per unit of this service over the time period the plan is billed for
▶▶▶future_rate_per_unit double   No

The future cost per unit of this service over the time period the plan is billed for
▶▶▶monthly_fee double   No

If the plan interval is more than one month, this field will rate per unit per month
▶▶▶weekly_fee double   No

If the plan interval is more than one week, this field will rate per unit per week
▶▶▶daily_fee double   No

If the plan interval is more than one day, this field will rate per unit per day
▶▶▶client_rate_schedule_id string 100 No

Client assigned unique rate schedule number
▶▶▶rate_tier_description string 50 No

Rate Tier Description
End of plan_service_rates object
Start of all_plan_service_rates object
▶▶all_plan_service_rates object   No

All rates for all rate schedules and currencies for this plan
Name Type Length Required Description
▶▶▶schedule_no long   No

Rate schedule number
▶▶▶client_rate_schedule_id string 100 No

Client assigned unique rate schedule number
▶▶▶future_rate long   No

Indicates whether future rates are captured or not.

Allowed values:

Value Description
0 false, i.e., no future rate.
1 True, i.e., future rates are captured.
Null null, i.e., no future rate.
▶▶▶future_change_date string 50 No

Future Change Date of the rates.
▶▶▶followup_rs_no long 50 No

Aria internal ID of follow-up default rate schedule
▶▶▶client_followup_rs_id string 50 No

Client-defined ID of followup rate schedule
Start of plan_service_rates object
▶▶▶plan_service_rates object   No

Represents the rates for the default rate schedule for the default currency for the plan
Name Type Length Required Description
▶▶▶▶rate_seq_no long   No

Sequential number in the rate schedule for dertermining tiers
▶▶▶▶from_unit double   No

Tiered Units (from) This value represents the start of a tiered range of values.
▶▶▶▶to_unit double   No

Tiered Units (to) This value represents the end of the range for a single tier of values.
▶▶▶▶rate_per_unit double   No

The cost per unit of this service over the time period the plan is billed for
▶▶▶▶future_rate_per_unit double   No

The future cost per unit of this service over the time period the plan is billed for
▶▶▶▶monthly_fee double   No

If the plan interval is more than one month, this field will rate per unit per month
▶▶▶▶weekly_fee double   No

If the plan interval is more than one week, this field will rate per unit per week
▶▶▶▶daily_fee double   No

If the plan interval is more than one day, this field will rate per unit per day
▶▶▶▶client_rate_schedule_id string 100 No

Client assigned unique rate schedule number
▶▶▶▶rate_tier_description string 50 No

Rate Tier Description
End of plan_service_rates object
End of all_plan_service_rates object
▶▶usage_type_name string   No

The human-readable name of this usage type
▶▶usage_type_desc string   No

The long description of this usage type
▶▶usage_type_code string   No

Client-assigned identifier for the type of usage being recorded.
▶▶usage_unit_label string   No

The display-level description of the units this usage represents.
▶▶apply_usage_rates_daily long   No

Indicates whether or not this usage-based service is rated on a daily basis.

Allowed values:

Value 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   No

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.

Allowed values:

Value Description
0 The plan services rates are Tax Exclusive.
1 The plan services rates are Tax Inclusive.
▶▶usage_rating_time_ind long   No

Indicates whether rating is performed during load time or invoice time

Allowed values:

Value Description
0 Rating will be performed at billing time.
1 Rating will be performed at load time.
▶▶usage_record_rating_level_ind long   No

Indicates whether rating is performed at aggregate level or per usage record level.

Allowed values:

Value Description
0 Rating will be performed with aggregated usage units.
1 Rating will be performed at per usage record level.
▶▶usage_record_taxation_level_ind long   No

Indicates whether taxation is performed at aggregate level or per usage record level.

Allowed values:

Value Description
0 Taxation will be performed with aggregated usage charges.
1 Taxation will be performed at per usage record level.
End of plan_services object
Start of plan_rate_schedules_details object
▶plan_rate_schedules_details object   No

An array of the rate schedules for the requested plan
Name Type Length Required Description
▶▶schedule_no long   No

The ID of this rate schedule
▶▶client_rate_schedule_id string 100 No

Client assigned unique rate schedule number
▶▶schedule_name string   No

The name of this rate schedule
▶▶schedule_currency string   No

The currency this rate schedule is linked to
▶▶recurring_billing_interval long   No

Number of months between billing cycles for recurring
▶▶usage_billing_interval long   No

Number of months between billing cycles for usage
▶▶recurring_billing_period_type long   No

Period type for billing cycles for recurring

Allowed values:

Value Description
1 Period type for recurring billing cyle is Daily
2 Period type for recurring billing cyle is Weekly
3 Period type for recurring billing cyle is Monthly
4 Period type for recurring billing cyle is Quarterly
5 Period type for recurring billing cyle is Yearly
▶▶usage_billing_period_type long   No

Period type for billing cycles for usage

Allowed values:

Value Description
1 Period type for usage billing cyle is Daily
2 Period type for usage billing cyle is Weekly
3 Period type for usage billing cyle is Monthly
4 Period type for usage billing cyle is Quarterly
4 Period type for usage billing cyle is Yearly
▶▶default_ind long   No

If true, this is the default rate schedule for the default currency

Allowed values:

Value Description
0 Rate schedule is not the default.
1 Rate schedule is the default.
▶▶default_ind_curr long   No

If true, this is the default rate schedule for the specified currency

Allowed values:

Value Description
0 Rate schedule is not default for specified currency.
1 Rate schedule is default for specified currency.
▶▶schedule_display_ind long   No

Determines whether the rate schedule is displayable

Allowed values:

Value Description
0 Rate schedule is not displayable.
1 Rate schedule is displayable.
▶▶available_from_dt string 100 No

Start date of rate schedule
▶▶available_to_dt string 100 No

End date of rate schedule
▶▶followup_rs_no long 100 No

Aria internal ID of follow-up default rate schedule
▶▶client_followup_rs_id string 100 No

Client-defined ID of followup rate schedule
End of plan_rate_schedules_details object
▶contract_rollover_plan_no long   No

Pre-defined plan to be used as the rollover plan at the completion of the contract.
▶contract_rollover_client_plan_id string 100 No

Client-defined ID of the pre-defined plan to be used as the rollover plan at the completion of a contract.
Start of contract_rollover_rate_sched object
▶contract_rollover_rate_sched object   No  
Name Type Length Required Description
▶▶contract_current_rate_sched_no long   No

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   No

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   No

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   No

Client-defined ID of the pre-defined rate schedule to be used as the rollover rate schedule at the completion of the contract
End of contract_rollover_rate_sched object
Start of plan_nso_incl_list object
▶plan_nso_incl_list object   No

Non-Subscription Offerings inclusion list that is in addition to NSOs that are bundled with the plan
Name Type Length Required Description
▶▶item_no long 22 No

Inventory item number
▶▶active_ind long   No

Inventory item status.

Allowed values:

Value Description
0 Inventory item is not active.
1 Inventory item is active.
End of plan_nso_incl_list object
Start of plan_groups object
▶plan_groups object   No

A grouping of plans which can be used for plan assignment
Name Type Length Required Description
▶▶plan_group_no long   No

The ID of this plan group
▶▶plan_group_name string   No

The name of this plan group
▶▶plan_group_desc string   No

The long description of this plan group
▶▶plan_group_usage string   No

Determines where the plan groups are made available

Allowed values:

Value Description
C By CSRs only within AdminTools
U Within your User Self Service applications only
B For both CSR and USS
▶▶selectable_ind long   No

Whether or not this plan group is selectable

Allowed values:

Value Description
0 Plan group is not selectable.
1 Plan group is selectable.
▶▶client_plan_group_id string 100 No

Client-defined ID for this plan group
End of plan_groups object
Start of promotional_plan_sets object
▶promotional_plan_sets object   No

A grouping of plans based on promo code
Name Type Length Required Description
▶▶promo_set_no long   No

The ID of this promotional plan set
▶▶promo_set_name string   No

The name of this promotional plan set
▶▶promo_set_desc string   No

The long description of this promotional plan set
Start of promotions_for_set object
▶▶promotions_for_set object   No

The promo codes associated with this group of plans
Name Type Length Required Description
▶▶▶promo_code string 100 No

The promo code itself
▶▶▶promo_code_desc string   No

A long description of this promo code
End of promotions_for_set object
▶▶client_promo_set_id string 100 No

Client-defined ID of this promotional plan set
End of promotional_plan_sets object
Start of parent_plans object
▶parent_plans object   No

The plans which are mapped as parents of this plan
Name Type Length Required Description
▶▶parent_plan_no long   No

ID of the parent plan
▶▶parent_plan_name string   No

Name of the parent plan
▶▶client_parent_plan_id string 100 No

Client-defined unique parent Plan ID
End of parent_plans object
Start of plan_supp_fields object
▶plan_supp_fields object   No

Supplemental object fields associated with this plan
Name Type Length Required Description
▶▶plan_supp_field_no long   No

Supplemental object field ID
▶▶plan_supp_field_name string   No

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   No

Description of the supplemental object field
▶▶plan_supp_field_value string   No

The value in this supplemental field on the plan
End of plan_supp_fields object
▶first_retrieval_level_ind string   No

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 decendant) of a plan which met the initial criteria

Allowed values:

Value 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.
Start of child_plans object
▶child_plans object   No

The plans which are mapped as children of this plan
Name Type Length Required Description
▶▶plan_no long 22 No

Aria generated unique ID of the plan.
▶▶client_plan_id string   No

Client-defined unique ID for the plan.
▶▶is_mandatory long   No

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

Allowed values:

Value Description
0 non-mandatory (default)
1 mandatory
▶▶is_default string   No

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

Allowed values:

Value 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   No

Determines the minimum number of units that must be purchased.
▶▶max_units string   No

Determines the maximum number of units that can be purchased.
▶▶enforcement_level string   No

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

Allowed values:

Value 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
End of child_plans object
Start of plan_nso_items object
▶plan_nso_items object   No

Non-Subscription Offerings that are bundled with the plan.
Name Type Length Required Description
▶▶item_no long 22 No

Inventory item number that is bundled with the plan
▶▶active_ind long   No

Inventory item status.

Allowed values:

Value Description
0 Inventory item is not active.
1 Inventory item is active.
▶▶min_qty string   No

Minimum NSO quantity needed during plan purchase
▶▶max_qty string   No

Maximum NSO quantity needed during plan purchase
▶▶item_scope long   No

Scope of bundled NSO during plan purchase.

Allowed values:

Value Description
0 Up to Plan Units
1 Match Plan Units
2 Any Units
Start of plan_nso_price_override object
▶▶plan_nso_price_override object   No

Overridden prices for NSO items.
Name Type Length Required Description
▶▶▶rate_schedule_no long   No

The internal Id of the rate schedule
▶▶▶client_rate_schedule_id string   No

Client assigned unique rate schedule number
▶▶▶currency_cd string   No

Currency code for Inventory item.
▶▶▶override_price string   No

Note: This field is deprecated. Aria no longer supports override_price.
▶▶▶bundle_nso_rate_schedule_no long   No

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   No

Client-defined unique identifier for the rate schedule to be used as the bundle price for the NSO when purchased with this plan.
End of plan_nso_price_override object
End of plan_nso_items object
Start of plan_nso_group object
▶plan_nso_group object   No

Non-Subscription Offerings that are bundled with the plan as part of NSO group
Name Type Length Required Description
▶▶item_no long 22 No

Inventory item number that is bundled with the plan
▶▶active_ind long   No

Inventory item status.

Allowed values:

Value Description
0  
1  
Start of plan_nso_group_price_override object
▶▶plan_nso_group_price_override object   No

Overridden prices for NSO items.
Name Type Length Required Description
▶▶▶rate_schedule_no long   No

The internal Id of the rate schedule
▶▶▶client_rate_schedule_id string   No

Client assigned unique rate schedule number
▶▶▶currency_cd string   No

Currency code for Inventory item.
▶▶▶override_price string   No

Note: This field is deprecated. Aria no longer supports override_price.
▶▶▶bundle_nso_rate_schedule_no long   No

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   No

Client-defined unique identifier for the rate schedule to be used as the bundle price for the NSO when purchased with this plan.
End of plan_nso_group_price_override object
End of plan_nso_group object
▶nso_group_min_qty string   No

Minimum NSO quantity needed during plan purchase for the NSO group.
▶nso_group_max_qty string   No

Maximum NSO quantity needed during plan purchase for the NSO group.
▶nso_group_item_scope string   No

Scope of bundled NSO group during plan purchase.

Allowed values:

Value Description
U Up to Plan Units
M Match Plan Units
A Any Units
Start of plan_translation_dtls object
▶plan_translation_dtls object   No  
Name Type Length Required Description
▶▶plan_no long 22 No

Aria-assigned unique plan identifier
▶▶locale_name string 100 No

Name of the locale.
▶▶plan_name string   No

The short name of this plan.
▶▶plan_desc string   No

The long description of this plan.
▶▶locale_no long 30 No

Aria-assigned unique identifier of the locale used for translations. This value must be unique across all Aria clients.
Start of plan_service_t object
▶▶plan_service_t object   No  
Name Type Length Required Description
▶▶▶service_no long   No

The unique ID for the service this line represents.
▶▶▶service_desc string   No

The name of the service this line represents.
Start of all_service_supp_fields_t object
▶▶▶all_service_supp_fields_t object   No  
Name Type Length Required Description
▶▶▶▶field_name string   No

The machine-readable name of this field
▶▶▶▶field_desc string   No

The human-readable name of this field
▶▶▶▶field_order_no long   No

The sort order of this field
▶▶▶▶field_value string   No

The value stored in this field
End of all_service_supp_fields_t object
Start of plan_service_rates_t object
▶▶▶plan_service_rates_t object   No

Represents the rates for the default rate schedule for the default currency for the plan.
Name Type Length Required Description
▶▶▶▶rate_seq_no long   No

Sequential number in the rate schedule for dertermining tiers
▶▶▶▶rate_schedule_name string 50 No

Rate Tier Description
▶▶▶▶rate_tier_description string 50 No

Rate Tier Description
End of plan_service_rates_t object
▶▶▶usage_type_name string   No

The human-readable name of this usage type
▶▶▶usage_type_desc string   No

The long description of this usage type
▶▶▶usage_unit_label string   No

The display-level description of the units this usage represents.
Start of plan_supp_fields_t object
▶▶▶plan_supp_fields_t object   No

Supplemental object fields associated with this plan
Name Type Length Required Description
▶▶▶▶plan_supp_field_no long   No

Supplemental object field ID
▶▶▶▶plan_supp_field_name string   No

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   No

Description of the supplemental object field
▶▶▶▶plan_supp_field_value string   No

The value in this supplemental field on the plan
End of plan_supp_fields_t object
End of plan_service_t object
End of plan_translation_dtls object
End of all_client_plan_dtls object
TOP
  1. Back to top
  • Was this article helpful?

Recommended articles

  1. Page type
    Topic
  2. Tags
    This page has no tags.