get_plans_by_promo_code_m
Summary
| API Name | get_plans_by_promo_code_m |
|---|---|
| Class | account_services_m |
| Update Version | 6.45 |
Description
Returns a summary list of plans associated with a specified promotion code.
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. |
||||||
| promo_code | string | 100 | Yes |
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 | 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:
|
||||||
| 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:
|
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. |
|
| plan_details | object | No |
This return value is a multidimensional array describing the detail of all available plans on this promo code. |
plan_details.plan_rate_schedules_details fields
| 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:
|
|||||||||||||
| usage_billing_period_type | long | No |
Period type for billing cycles for usage Allowed values:
|
|||||||||||||
| default_ind | long | No |
If true, this is the default rate schedule for the default currency Allowed values:
|
|||||||||||||
| default_ind_curr | long | No |
If true, this is the default rate schedule for the specified currency Allowed values:
|
|||||||||||||
| schedule_display_ind | long | No |
Determines whether the rate schedule is displayable Allowed values:
|
|||||||||||||
| 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 |
plan_details.contract_rollover_rate_sched fields
| 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 |
plan_details.plan_translation_info fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| plan_no | long | 22 | No |
Aria-assigned plan identifier. This value is unique across all Aria-managed accounts. |
| locale_name | string | 100 | No |
Name of the locale. |
| plan_name | No | |||
| plan_desc | No | |||
| locale_no | long | 30 | No |
Aria-assigned unique identifier of the locale used for translations. This value must be unique across all Aria clients. |
| actual_plan_no | No |
plan_details fields
| 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 |
Whether or not this is a supplemental plan. If not, it is a master plan Allowed values:
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| billing_ind | long | No |
Indicates whether or not this plan is billable Allowed values:
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| display_ind | long | No |
Indicates whether or not the plan is marked as "displayable". 0 means not displayable. 1 means displayable. Allowed values:
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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:
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| rollover_acct_status | long | No |
Default status for new accounts created on this plan. Allowed values:
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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:
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| prepaid_ind | long | No |
Indicates whether or not this plan is prepaid Allowed values:
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| currency_cd | string | No |
The currency_cd of the default rate schedule associated to the plan. This is the 3-character ISO-compliant currency code in lowercase for monetary values. (exp. "usd" = US Dollars, "cad" = Canadian Dollars). |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| client_plan_id | string | 100 | No |
Client-defined Plan ID for which to query available child plans |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| client_rollover_plan_id | string | 100 | 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 client rollover plan ID. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| client_plan_id_2_assign_on_susp | string | 100 | No |
Client-defined Plan ID to assign when an account on this plan is suspended. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| rollover_plan_duration | long | 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:
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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 | long | No |
Units associated with the duration of the initial free period (used in conjunction with init_free_period_duration). Allowed values:
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| initial_plan_status_cd | long | No |
Default status used when master plan is initially assigned on an account. Allowed values:
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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:
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| rollover_plan_status_cd | long | No |
Status used for the master plan instance at the completion of the plan status rollover period. Allowed values:
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| plan_rate_schedules_details | object | No |
An array of the rate schedules for the requested plan |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| contract_rollover_rate_sched | object | No | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| plan_translation_info | object | No |