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

Client-defined account identifier.

Alternative required field: acct_no

The Master Subscription plan instance number.

Client-defined Master plan Subscription plan instance ID.

Flag when false will suppress the unbilled usage detail records.

Flag decides whether to return values of all plans/usage types or not.

The unique plan identifier.

Alternative field: plan_instance_no or client_plan_instance_id

The Aria-assigned usage type number to set the threshold unit amount per specific usage type.

Alternative field: usage_type_cd

Client-assigned identifier for the type to set the threshold unit amount per specific usage type. Either this field OR "usage_type_no" must be passed into the API to denote which usage type to set the threshold unit.

Alternative field: usage_type_no

Use this field to include usage records that have been permanently excluded from billing

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

The Aria defined unique identifier of the plan instance (can be either a master or supplemental plan).

Alternative field: plan_no or client_plan_instance_id

The client-defined identifier of the plan instance (can be either a master or supplemental plan)

Alternative field: plan_no or plan_instance_no

Aria-assigned error identifier. 0 indicates no error.

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

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

Human-readable currency name, in English.

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

Client-defined account identifier.

The Master Subscription plan instance number.

Client-defined Master plan Subscription plan instance ID.

The month-to-date threshold amount which, when crossed over or under by the account's running month-to-date unbilled usage balance, triggers an email notification of such to the account holder (if client is configured for such notices).

The billing-period-to-date threshold amount which, when crossed over or under by the account's running billing-period-to-date unbilled usage balance, triggers an email notification of such to the account holder (if client is configured for such notices).

The month-to-date threshold amount which, when crossed over or under by the account's running month-to-date unbilled usage balance, triggers provisioning event notification of such to the client (if client is configured for receipt of such events).

The billing-period-to-date threshold amount which, when crossed over or under by the account's running billing-period-to-date unbilled usage balance, triggers provisioning event notification of such to the client (if client is configured for receipt of such events).

The account's current month-to-date unbilled usage currency value.

The account's current billing-period-to-date unbilled usage currency value.

A symbolic indicator as to whether the value in parameter "mpi_mtd_delta_amount" is above, below, or equal to its associated threshold value.

A symbolic indicator as to whether the value in parameter "mpi_mtd_delta_amount" is above, below, or equal to its associated threshold value.

A symbolic indicator as to whether the value in parameter "mpi_ptd_delta_amount" is above, below, or equal to its associated threshold value.

A symbolic indicator as to whether the value in parameter "mpi_mtd_delta_amount" is above, below, or equal to its associated threshold.

A symbolic indicator as to whether the value in parameter "client_mtd_delta_amount" is above, below, or equal to its associated threshold value.

The threshold amount of usage minus the unbilled amount of usage. Used in conjunction with the delta sign, which indicates if the value is above, below, or equal to the client's threshold amount for the month to date.

A symbolic indicator as to whether the value in parameter "client_mtd_delta_amount" is above, below, or equal to its associated threshold value.

The threshold amount of usage minus the unbilled amount of usage. Used in conjunction with the delta sign, which indicates if the value is above, below, or equal to the client's threshold amount for the period to date.

The account's current unapplied usage currency value.

A symbolic indicator as to whether the value in parameter "unapp_svc_credit_delta_amount" is above, below, or equal to its initial value.

The amount of usage minus the amount of the service credit. Used in conjunction with the delta sign, which indicates if the value is above, below, or equal to the amount of the unapplied service credit.

See fields below

See fields below

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

Name of the account level locale.

Array of usage tax details

See fields below

The Subscription plan instance number.

Aria-assigned unique identifier representing the type of usage that is being recorded.

The name of this usage type used on all reports, account statements, etc., E.g. International Call Minutes

The date on which the given usage was incurred.

The number of units incurred by the account holder.

The rated monetary charge this record will be billed as

Rate entered while recording usage

The number of units recorded by the account holder.

Aria-assigned usage parent record identifier.

The usage type code of this record

The reason why this usage record has been excluded from billing

Aria-assigned usage record identifier.

The client-defined identifier of the plan instance (can be either a master or supplemental plan).

Flag to differentiate Client calculated and Aria calculated taxes.

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.

Returns the threshold level for the threshold_units

Returns the threshold value against the level_no

Returns the delta usge units balance.

A symbolic indicator as to whether the value in parameter "delta_usage_units_bal" is above, below, or equal to its associated threshold value.

Returns the number of plan no.

Returns the number of usage type.

Returns a string representing the threshold destination type either Account A or Client C.

Returns a string representing the threshold balance type either month-to-date or billing-period-to-date.

Returns the number of threshold units.

Returns the number of usage units measured.

The Aria defined unique identifier of the plan instance (can be either a master or supplemental plan).

The client-defined identifier of the plan instance (can be either a master or supplemental plan).

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

See fields below

Aria-assigned usage record identifier.

Line number associated with each tax detail record.

Amount of tax applied for the given tax type.

Rate at which tax is calculated for the tax type used by the tax engine.

Taxable amount of the tax type returned by the tax engine.

Jurisdiction name returned by the tax engine.

Tax jurisdiction code

Identifier of the tax type returned by the tax engine.

Description of the tax type returned by the tax engine.

Category of the tax type returned by the tax engine.

Summary text returned by the tax engine.

Specifies whether or not this tax record is included for invoicing.