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_plans | 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_interval | long | Number of months between billing cycles |
billing_ind | long | Indicates whether or not this plan is billable Allowable Values Values | Description | 0 | 0 | 1 | 1 | |
display_ind | long | Indicates whether or not the plan is marked as "displayable". 0 means not displayable. 1 means displayable. Allowable Values Values | Description | 0 | 0 | 1 | 1 | |
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 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 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 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 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 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. | |
plan_services | hash | A multidimensional array of Services for this plan |
service_no | long | A multidimensional array of 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 Values | Description | 0 | 0 | 1 | 1 | |
is_usage_based_ind | long | Indicates whether or not this service is a usage based service Allowable Values Values | Description | 0 | 0 | 1 | 1 | |
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 Values | Description | 0 | 0 | 1 | 1 | |
is_tax_ind | long | Indicates whether or not this service is a tax based service Allowable Values Values | Description | 0 | 0 | 1 | 1 | |
is_arrears_ind | long | Indicates whether or not this service is an arrears based service Allowable Values Values | Description | 0 | 0 | 1 | 1 | |
is_setup_ind | long | Indicates whether or not this service is a setup bases service Allowable Values Values | Description | 0 | 0 | 1 | 1 | |
is_misc_ind | long | Indicates whether or not this service is a miscellaneous service Allowable Values Values | Description | 0 | 0 | 1 | 1 | |
is_donation_ind | long | Indicates whether or not this service is a donation based service Allowable Values Values | Description | 0 | 0 | 1 | 1 | |
is_order_based_ind | long | Indicates whether or not this service is an order based service Allowable Values Values | Description | 0 | 0 | 1 | 1 | |
is_cancellation_ind | long | Indicates whether or not this service is a cancellation based service Allowable Values Values | Description | 0 | 0 | 1 | 1 | |
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 Values | Description | 0 | 0 | 1 | 1 | |
tiered_pricing_rule | long | The Tiered Pricing Rule Allowable Values 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 Values | Description | 0 | 0 | 1 | 1 | |
client_service_id | string | A multidimensional array of client-defined Service ID for this plan. |
usage_type_cd | string | An array containing usage_type_cd(s) to denote which usage type(s) 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. |
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 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 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 Values | Description | 0 | usage shall be rated based on the entire billing period | 1 | usage shall be rated based on one day periods individually. | |