Home > Aria Crescendo core api > get_plans_by_promo_code_all_m
get_plans_by_promo_code_all_m
get_plans_by_promo_code_all_m
Table of contents
- Input Arguments
- Allowable values for include_rs_summary
- Allowable values for retrieve_bundled_nso
- Allowable values for retrieve_included_nso
- Allowable values for include_translations
- Output Arguments
- Allowable values for billing_ind
- Allowable values for display_ind
- Allowable values for new_acct_status
- Allowable values for rollover_acct_status
- Allowable values for default_notify_method
- Allowable values for prepaid_ind
- Allowable values for proration_invoice_timing_cd
- Allowable values for rollover_plan_uom_cd
- Allowable values for init_free_period_uom_cd
- Allowable values for initial_plan_status_cd
- Allowable values for rollover_plan_status_uom_cd
- Allowable values for rollover_plan_status_cd
- Allowable values for nso_incl_list_scope
- Allowable values for is_recurring_ind
- Allowable values for is_usage_based_ind
- Allowable values for taxable_ind
- Allowable values for is_tax_ind
- Allowable values for is_arrears_ind
- Allowable values for is_setup_ind
- Allowable values for is_misc_ind
- Allowable values for is_donation_ind
- Allowable values for is_order_based_ind
- Allowable values for is_cancellation_ind
- Allowable values for display_ind
- Allowable values for tiered_pricing_rule
- Allowable values for is_min_fee_ind
- Allowable values for future_rate
- Allowable values for apply_usage_rates_daily
- Allowable values for tax_inclusive_ind
- Allowable values for default_ind
- Allowable values for default_ind_curr
- Allowable values for schedule_display_ind
- Allowable values for active_ind
- Allowable values for item_scope
- Allowable values for active_ind
- Allowable values for nso_group_item_scope
- Allowable values for active_ind
Returns a detailed list of plans associated with a specified promotion code. The information returned includes the services and rate schedules associated with the plans.
Input Arguments
| Req | Field Name | Field Type | Max Length | Description |
|---|---|---|---|---|
 |
client_no | long | 22 | Aria-assigned unique identifier indicating the Aria client providing service to this account. |
|
auth_key | string | 32 | Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor. |
| promo_code | string | 100 | This is the code provided the client and used by the account holder during registration or when executing a transaction.A promotion generally provides access to a custom set of reduced-rate plans. | |
| include_rs_summary | string | 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". Allowable Values | ||
| retrieve_bundled_nso | string | If set to "true", will retrieve all of the bundled inventory items associated with a particular plan. If left blank, will default to "false". Allowable Values | ||
| retrieve_included_nso | string | If set to "true", will retrieve all of the inventory items associated with a particular plan. If left blank, will default to "false". Allowable Values | ||
| locale_no | long | 22 | Aria-assigned unique identifier of the locale used for translations. This value must be unique across all Aria clients. | |
| OR | ||||
| locale_name | string | 100 | Name of the locale. | |
| include_translations | string | Setting this flag as True will fetch the translated fields in all the locales defined. If not passed it defaults to False. Allowable Values | ||
| alt_caller_id | string | 30 | Person or process that submitted the API call. This can be someone's user ID, or the name of an application. | |
| optional_transaction_qualifiers | array | Array of additional values you can associate with this API call. | ||
 qualifier_name |
string | 100 | Name of the field you want to associate with this API call. | |
| qualifier_value |
string | 100 | Corresponding value of the field you want to associate with this API call. |
Output Arguments
| Field Name | Field Type | Description |
|---|---|---|
| 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_plan_details | hash | This return value is a multidimensional array describing the detail of all available plans. |
| plan_no |
long | Aria-assigned unique plan identifier |
| plan_name |
string | Plan Name |
| plan_desc |
string | Text description of this plan |
| billing_ind |
long | Indicates whether or not this plan is billable Allowable Values |
| display_ind |
long | Indicates whether or not the plan is marked as "displayable". 0 means not displayable. 1 means displayable. Allowable Values |
| 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 |
| rollover_acct_status |
long | Default status for new accounts created on this plan. Allowable Values |
| 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 |
| prepaid_ind |
long | Indicates whether or not this plan is prepaid Allowable Values |
| 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-defined Plan ID for which to query available child plans |
| client_rollover_plan_id |
string | 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 client rollover plan ID. |
| client_plan_id_2_assign_on_susp |
string | Client-defined Plan ID to assign when an account on this plan is suspended. |
| 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 |
| rollover_plan_duration |
long | 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 |
| 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 |
long | Units associated with the duration of the initial free period (used in conjunction with init_free_period_duration). Allowable Values |
| initial_plan_status_cd |
long | Default status used when master plan is initially assigned on an account. Allowable Values |
| 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 |
| rollover_plan_status_cd |
long | Status used for the master plan instance at the completion of the plan status rollover period. Allowable Values |
| nso_incl_list_scope |
long | Scope of additional NSO as part of inclusion list. Allowable Values |
| 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 |
| is_usage_based_ind |
long | Indicates whether or not this service is a usage-based service Allowable Values |
| 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 |
| is_tax_ind |
long | Indicates whether or not this service is a tax-based service Allowable Values |
| is_arrears_ind |
long | Indicates whether or not this service is an arrears-based service Allowable Values |
| is_setup_ind |
long | Indicates whether or not this service is a setup-based service Allowable Values |
| is_misc_ind |
long | Indicates whether or not this service is a miscellaneous service Allowable Values |
| is_donation_ind |
long | Indicates whether or not this service is a donation-based service Allowable Values |
| is_order_based_ind |
long | Indicates whether or not this service is an order-based service Allowable Values |
| is_cancellation_ind |
long | Indicates whether or not this service is a cancellation- based service Allowable Values |
| 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 |
| tiered_pricing_rule |
long | The Tiered Pricing Rule Allowable Values |
| is_min_fee_ind |
long | Indicates whether or not this service is a minimum fee. Allowable Values |
| 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 dertermining 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 |
| 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 dertermining 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 |
| tax_inclusive_ind |
long |
Indicator that states whether a taxable service is tax-inclusive or tax-exclusive. Allowable Values |
| 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 |
| default_ind |
long | If true, this is the default rate schedule for the default currency Allowable Values |
| default_ind_curr |
long | If true, this is the default rate schedule for the specified currency Allowable Values |
| schedule_display_ind |
long | Determines whether the rate schedule is displayable Allowable Values |
| 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_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 |
| 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 |
| plan_nso_price_override |
hash | Overridden prices for NSO items. |
| rate_schedule_no |
long | The internal Id of the rate schedule |
| client_rate_schedule_id |
string | Client assigned unique rate schedule number |
| currency_cd |
string | Currency code for Inventory item. |
| override_price |
string | Overridden price for Inventory item for currencies. |
| 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 |
| plan_nso_group_price_override |
hash | Overridden prices for NSO items. |
| rate_schedule_no |
long | The internal Id of the rate schedule |
| client_rate_schedule_id |
string | Client assigned unique rate schedule number |
| currency_cd |
string | Currency code for Inventory item. |
| override_price |
string | Overridden price for Inventory item for currencies. |
| 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 |
| 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 |
| plan_translation_details |
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. |
| rate_scheds_t |
hash | |
| schedule_no |
long | The ID of this rate schedule. |
| schedule_name |
string | The name of this rate schedule. |
| plan_services_t |
hash | |
| service_no |
long | The unique ID for the service this line represents. |
| service_name |
string | The name of the service this line represents. |
- © Copyright 2019 Aria Developer Central