Aria-assigned unique identifier indicating the Aria client providing service to this account.

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

Aria-assigned account identifier. This value is unique across all Aria-managed accounts.

Alternative required field: client_acct_id

Indicates whether to include the service supplemental fields array. If set to "true", will retrieve all of service supplemental fields If left blank, will default to "true".

Limits the number of records returned in the all_acct_plans_m array. Min of 1 and Max 999. If no value specified, the default is 100.

The number of records to skip in the all_acct_plans_m array. Min of 0 with no maximum value. If no value specified the default is 0.

Indicates whether to include the product fields array. If set to "true", will return the product fields array. If left blank, will default to "true".

Indicates whether to include the plans instance fields array. If set to "true", will return array. If left blank, will default to "true".

Indicates whether to include the plans services array. If set to "true", will return array. If left blank, will default to "true".

Indicates whether to include the surcharges array. If set to "true", will return array. If left blank, will default to "true".

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

Alternative field: locale_name

Name of the locale.

Alternative field: locale_no

If the include_rate_schedule parameter is set to True or left null, then all of the rate schedule information for each plan will be returned. If set to False, this information will be excluded from the response.

If the include_contract_and_rollover_info parameter is set to True or left null, then all of the contract and rollover information for each plan will be returned. If set to False, this information will be excluded from the response.

If the include_dunning_info parameter is set to True or left null, then all of the dunning information for each plan will be returned. If set to False, this information will be excluded from the response.

This array will support up to 10 individual inputs.

See fields below

This array will support up to 10 individual inputs.

See fields below

This array will support up to 10 individual inputs.

See fields below

This array will support up to 10 individual inputs.

See fields below

Client-defined account identifier.

Alternative required field: acct_no

The Aria-assigned unique plan identifier that will be used to filter the results for this API. If the plan instance doesn't have this plan_no assigned, it will not be returned.

Alternative field: client_plan_id

The client-defined unique identifier for the plan that will be used to filter the results for this API. If the plan instance doesn't have this plan name assigned, it will not be returned.

Alternative field: plan_no

The Aria-assigned unique service identifier that will be used to filter the results for this API. If the plan instance doesn't have this service_no assigned, it will not be returned.

Alternative field: client_service_id

The client-defined unique identifier for the service that will be used to filter the results for this API. If the plan instance doesn't have the service with this description assigned, it will not be returned.

Alternative field: service_no

The Aria-assigned unique identifier of the master plan that will be used to filter the results for this API. Results will only display for plans related to the master plan instance provided.

Alternative field: client_master_plan_instance_id

The client-defined unique identifier of the master plan that will be used to filter the results for this API. Results will only display for plans related to the master plan instance provided.

Alternative field: master_plan_instance_no

Name of the supplemental field associated with a plan that will be used to filter results.

Value for the supplemental field listed above that will be used to filter results.

Aria-assigned error identifier. 0 indicates no error.

Description of any error that occurred. "OK" if there was no error.

Returns a total count of the number of records.

See fields below

Name of the account level locale.

Aria-assigned unique identifier of the locale used for translations. This value is unique across all Aria-managed accounts.

Name of the product field associated with the plan in the product catalog.

Value associated with the product field as defined in the product catalog.

Name of the plan instance field

Value associated with the plan instance field

The machine-readable name of this field

The human-readable name of this field

The sort order of this field

The value stored in this field

Sequential number in the rate schedule for determining tiers

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

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

The cost per unit of this service over the time period the plan is billed for

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

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

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

If the plan interval is more than one day, this field will rate per unit per day

Rate Tier Description

Identifies whether this is a custom rate. A value of 1 indicates that it is a custom rate. A value of 0 indicates that it is a standard rate.

The services for this plan

Description of this service

Indicates whether or not this service is a recurring service

Indicates whether or not this service is a usage based service

The usage type supported by this usage based service

Indicates whether or not this service is taxable

Indicates whether or not this service is a tax based service

Indicates whether or not this service is an arrears based service

Indicates whether or not this service is a setup bases service

Indicates whether or not this service is a miscellaneous service

Indicates whether or not this service is a donation based service

Indicates whether or not this service is an order based service

Indicates whether or not this service is a cancellation based service

Chart of accounts ID

This field is deprecated in favor of coa_id

The client-defined override for coa_id

Indicates if this service is displayable or not

The Tiered Pricing Rule

Indicates whether or not this service is a minimum fee.

The client-defined Service ID for this plan.

Denotes which usage type to record.

See fields below

Indicates if the service is Fulfillment Based or not.

The human-readable name of this usage type

The long description of this usage type

Client-assigned identifier for the type of usage being recorded.

The display-level description of the units this usage represents.

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

The Aria-assigned unique identifier for the origin location for the specified service associated with the plan. Depending on taxation configuration, this address may be used for tax calculations.

The client-defined unique identifier for the origin location for the service associated with the plan. Depending on taxation configuration, this address may be used for tax calculations.

The name of the origin location for the service.

Company name of the service location.

First address line of the service location.

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.

Third address line of the service location.

City of the service location.

Locality of the service location.

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.

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

Postal/Zip code for the service location address.

The Aria-assigned unique identifier for the destination contact for the specified service associated with the plan. Depending on taxation configuration, this address may be used for tax calculations.

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.

Represents the rates for the plan instance

See fields below

Indicates whether rating is performed during load time or invoice time

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

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

Aria-assigned unique rate sequence number

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

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

This is the rate for the tiered units specified by from and to unit values above.

This indicator indicates whether the rate schedule has includes zero or not.

This indicator indicates the assigned rate schedule for the surcharge.

Rate Tier Description

Surcharge number for this plan

Surcharge name for this plan

Client-defined surcharge ID.

description for surcharge.

External Description for surcharge.

Surcharge type for the plan.

Currency for this surcharge plan

If taxable, the tax group this item belongs to

Invoice application method of this plan surcharge

Revenue Account GL Code for this plan surcharge

Accounts Recievable GL Code for this plan surcharge

A multidimensional array of Surcharges Rate for this plan'

See fields below

Aria-assigned unique plan identifier

Plan Name

Text description of this plan

Unique plan instance number for each assigned master plan.

Unique client-defined ID for each assigned master plan.

Date on which the account was assigned to their current plan.

Number of plan units the account is billed for.

The date the account was last billed

Date the account will be evaluated for invoicing, whether or not it results in any actual charges.

Date the accounts forward charges have been billed through.

Day of the month that the account is billed.

Number of months between billing cycles

Number of months between billing cycles

Period type for billing cycles for recurring

Period type for billing cycles for usage

Indicates whether or not this plan is billable

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

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

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.

Fee charged for early cancellations.

Number of months during which early cancellation fees would apply on master plan cancellation. Not applicable to supplemental plans.

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.

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

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

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

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

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

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

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

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

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

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

The billing group number.

Client-defined billing group ID.

Dunning group number

Client-defined unique identifier for dunning group

Plan to assign when an account on this plan is suspended.

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

Indicates whether or not this plan is prepaid

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

Aria-assigned unique rate schedule number

Name of the rate schedule

Indicates whether or not the account is using the plans default rate schedule. 0 means the account is using an alternate rate schedule. 1 means the account is using the default rate schedule.

Indicates whether or not the plan is a supplemental plan. If it is "1", then the plan is a supplemental plan and if it is "0", then the plan is a master plan.

Current status code of the plan instance.

Current status of the plan instance.

Most recent date on which the status of the plan instance changed.

Dunning state assigned to the master plan instance. In Progress indicates the master plan is in dunning. None indicates the master plan is not in dunning. Note that dunning state is applicable only for master plans and is set to Complete by the system once the dunning process is completed.

Current dunning step of the plan instance (applicable only for master plans currently in dunning).

Next future date on which the plan instance would advance to the next dunning step (applicable only for master plans currently in dunning).

The date on which the current plan was assigned on this plan instance.

The date on which the current plan on this plan instance was suspended, cancelled or terminated.

The API receipt ID used while creating this plan instance.

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

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.

CDID of the plan to be assigned when an account on this plan is suspended.

Client assigned unique rate schedule number

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

See fields below

See fields below

Master plan instance number for each supplemental plan.

Client master plan instance ID for each supplemental plan.

Parent plan instance number to identify each supplemental plan and child supplemental plan heirarchy.

Client parent plan instance ID to identify each supplemental plan and child supplemental plan heirarchy.

A multidimensional array of Services for this plan

See fields below

A multidimensional array of Surcharges for this plan'

See fields below

Pre-defined plan to be used as the rollover plan at the completion of the contract.

Client-defined ID of the pre-defined plan to be used as the rollover plan at the completion of a contract.

Pre-defined rate schedule to be used as the rollover rate schedule at the completion of the contract

Client-defined ID of the pre-defined rate schedule to be used as the rollover rate schedule at the completion of the contract

Purchase order number assigned to the plan instance.

Start date of assigned rate schedule

End date of assigned rate schedule

Aria internal ID of follow-up default rate schedule for the assigned rate schedule

Client-defined ID of followup rate schedule for the assigned rate schedule

The number of reset months for each plan

Determines whether the usage accumulation reset months will automatically reset to same value at the end of the current period or will expire at end of current period.

Number of months since last reset. Once this value reaches the usage_accumulation_reset_months value, it will reset to 0 (zero).

Bill lag days refer to the number of days prior to (negative) or after (positive) an account billing date at which an invoice should be generated for this Master Plan Instance. Negative bill lag days are typically used for subscription-based services (often subscription-based services paid using net-terms), in which the user would like to send out invoices to customers well in advance of the real invoice date. Positive bill lag days are typically used for usage-based services.

Plan Instance creation date.