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 unique identifier of the new plan replacing the existing plan on the instance.

Alternative required field: client_plan_inst_id

The client-defined identifier of the new plan replacing the existing plan on the instance.

Alternative required field: plan_inst_no

Array of plan units associated with this account. This remove action has precedence over adding units. Thus, if this array is present, then new_plan_units to add will be ignored.

See fields below

The rule to be applied to this assignment request, governing the proration rule is applied. Default behavior is to make the plan change (assign/deassign a plan to an account, change units on an existing plan, etc.) immediately based on client-defined default proration rule, resulting in appropriate prorated charge and credit.

Number of additional units of the specified plan to be assigned to the account

Array of Client-defined ID associated with the plan unit of the account

See fields below

Determines whether to create a separate invoice for prorated charges immediately, or defer to the next anniversary date. Note that this will override the Proration Invoice Timing configuration saved with the plan in the product catalog.

Boolean indicator that specifies whether to actually perform the requested operation. If 'false' is passed in this field, Aria calculates, if applicable, any potential effects from this call such as proration, plan assignments, etc. and return all relevant data without actually performing the requested operation or making any changes to the account. This is useful to interfaces that want to present the user with a 'confirmation page' informing them of the potential effects of the requested operation prior to actually performing it. Do_write defaults to 'true'

Defines a recurring payment type for Credit Card and Tokenized Credit Cards. A null value will default to 0 - Cardholder-Initiated Transaction - Credentials on File.

The unique identifier of the plan unit instance to be removed. This API expects all plan unit instances to be for the same plan_inst_no, or client_plan_inst_id.

Alternative field: client_plan_unit_inst_id

The client-defined identifier of the plan unit instance to be removed. This API expects all plan unit instances to be for the same plan_inst_no, or client_plan_inst_id.

Alternative field: plan_unit_inst_no

Client-defined ID to be used for a given plan unit being assigned to the account.

Aria-assigned error identifier. 0 indicates no error.

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

The currency amount of any resulting proration action performed as a result of the requested plan change. For plan assignments with an assignment directive of '1' (perform on anniversary date), or '2' (honor client default proration action) when the default configuration is to not do proration, or '3' (force no proration), the value returned in this field will always be '0'. When proration is performed the value returned in this field will either be a positive currency value (indicating a resulting charge to the account) or a negative currency value (indicating a credit to the account). If the value passed in field do_write is false then any positive or negative value returned in this field is notational only, demonstrating what proration effect would be applied to the account if the requested plan assignment/de-assignment were to be actually performed.

If a collection is attempted, returns the error code associated with the collection.

The error message associated with collection_error_code.

The error code if statement generation fails.

The text message associated with 'statement_error_code'

The processor return code from CVV validation.

Processor return code from address validation

The processors return code for security validation.

The processor status code

The processors status description

The processor payment ID

Authorization code provided by the issuing bank

Additional information passed to payment processor

Transaction ID from payment processor. If received as part of an auth request, it must be retained for future settlement and match the value from the auth response. It should also be used for future recurring transaction auths/settlement.

An array containing the supplemental plans cancelled.

See fields below

The Aria-assigned unique identifier of a given invoice.

The activation fee the account holder can expect based on the activation fees of the plans on this invoice

Regardless of the billing interval on the account, the monthly recurring cost of this change

See fields below

Total amount to be charged to the account before taxes have been calculated.

Total taxes as calculated for the amount of the transaction.

Total amount to be charged to the account after taxes have been calculated.

The total amount of the credit to be applied to the account

The tax amount of the credit to be applies

The credit to be applied before tax is taken into account

The grand total of this invoice

The total pro-rated credit amount

The non-tax pro-rated credit amount

The pro-rated tax credit amount

Payment response fields returned by the processor for further actions if any.

See fields below

The unique ID of the supplemental plan

The name of the supplemental plan

The result of the proration calculation for the unused portion of the billing period

Client-defined supplemental plan ID.

Field name of various response returned by the processor, example: micro_deposit_verify_url.

Field value for the corresponding payment response field, example: Actual URL to be used for the micro deposit verification.