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

The unique identifier of the account's plan instance that this API call will update.

Alternative required field: client_plan_instance_id

The client-defined identifier of the account's plan instance that this API call will update.

Alternative required field: plan_instance_no

Alternative Rate Schedule Number. The alt_rate_schedule_no is the unique identifier for an alternative rate schedule that can be assigned to the account holder in place of the default rate schedule. This is often done by CSR's to provide special compensation or discounts as incentives to account holders.

Alternative field: client_alt_rate_schedule_id

The units of the plan added at this change

An array of coupon details for the master plan instance.

See fields below

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.

Updates the plan status for the plan instance.

Updated the description for the plan instance.

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.

Additional explanatory text relating to this API call.

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'

Client-defined unique identifier used to track related system actions

An array of custom rates for the specified account number

See fields below

If the assignment directive is for a future date assignment, this is the date, in yyyy-mm-dd format, on which the plan change will be executed. If this field is NULL, then the plan change will not happen until it is manually executed or until the effective_date is updated.

If assigning a change on an anniversary day, the number of billing periods by which to delay that change. If the new plan is different from the old plan, and this value is greater than 0, then the billing date continues to be the annniversary date.

Overrides the "Sync_mstr_bill_dates_on_1st_supp" client-level setting that determines whether or not no-charge master plan billing dates should be reset when assigning a new supplemental plan or when the supplemental plan instance status is updated to a billable status. If this value is left empty, the client-level setting will take effect.

Client-defined alternate rate schedule identifier to assign (if any). If none is specified, the default rate schedule number will be used.

Alternative field: alt_rate_schedule_no

Updates the client-defined identifier associated with the plan instance.

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.

Date on which the Dunning Manager evaluates whether the master plan should be advanced to the next step of the dunning process. Applicable only for master plans, and only if the dunning_state is set to 1.

The responsibility level code. These are values 1 through 4 as described in the legend for this argument.

The number of reset months for each plan

Indicates whether usage pooling is enabled for this plan instance. Allowable values are 'true' and 'false'.

Usage tracking options on the plans in the account

Surcharge for master plan

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.

Purchase order number assigned to the plan instance.

List of services associated with the plan being assigned or updated on the account.

See fields below

This field controls the ability to update plan instance fields on a plan that is in non-provisioned status.

When a master plan's status changes from non-billable to billable, this input will determine what the billing dates of the specific master plan and all associated supplemental plans anniversary date will be.

Force currency change during update. Generally this is necessary when the update is taking place to accommodate for an account holder moving from one area to another where the local currency is different.

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.

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.

Boolean indicator to return the queues created on this api call.

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.

The processor-specific fields passed as an array of proc_field_name/proc_field_value key-value pairs. The allowable fields and values for the key-value pairs are highlighted in blue below.

See allowable proc_field_names

Determines the behavior when changing the rate schedule of a plan instance that is using custom rates. The default value is false and will leave the custom rates in place. A value of true will remove the custom rates and use the default rates of the new rate schedule.

Determines which dunning step to place the MPI into if you are placing this MPI into dunning or for moving the step of a MPI that is already in dunning. The default is 1 (step 1).

Determines whether or not to use the dunning configuration setting to charge a late fee applicable to that dunning step if you are placing this MPI/BG into dunning. The default is to use the configuration setting.

Determines whether or not to use the dunning configuration setting to send an email applicable to that dunning step if you are placing this MPI/BG into dunning. The default is to use the configuration setting.

The unique identifier of the master plan instance on the responsible account. Required if responsibility level is set to one of the two parent pay options.

Alternative field: resp_client_master_plan_instance_id

The client-defined identifier of the master plan instance on the responsible account. Required if responsibility level is set to one of the two parent pay options.

Alternative field: resp_master_plan_instance_no

Client-defined account identifier.

Alternative required field: acct_no

The date, in yyyy-mm-dd format, from which the proration calculations begin. If this field is NULL, then the proration calculations begin from the current date. This date cannot be before the beginning of the current billing period.

Unique identifier associated with an existing billing group for the specified account.

Alternative field: client_billing_group_id

Unique client-defined identifier associated with an existing billing group for the specified account.

Alternative field: billing_group_no

Number of months to add to the prorated period. For 'update', this is only applicable when there is a pullback of the recurring bill thru date either due to change in rate schedule with a change in billing interval or when the plan instance is being activated/re-activated. Additionally, when this is given for a parent plan instance being activated, then the auto-activated child plan instances will be automatically applied with auto_offset_months_option = 1 so that they remain synchronized with the parent plan instance.

Automatically set the offset for the billing anniversary month. For 'update', this is only applicable when there is a pullback of the recurring bill thru date either due to change in rate schedule with a change in billing interval or when the plan instance is being activated/re-activated.

Array of coupon details for the plan instance.

See fields below

Limit updates to specific objects only if a plan instance is already queued for a future assignment.

See fields below

The coupon codes to assign to this master plan instance, if any

Required if you wish to update a plan instance field value associated with the specified plan instance.

Required based on the definition of each plan instance field associated with the new plan.

Required for each plan instance field provided.

The surcharge directive to assign/remove the surcharge from the master plan instance

The Aria-assigned unique identifier for the service associated with the plan instance. Either this field or client_service_id is required to map plan services to the plan instance.

Alternative field: client_service_id

The client-defined identifier for the service associated with the plan instance.

Alternative field: service_no

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. If both svc_location_no and client_svc_location_id are provided, svc_location_no will take precedence.

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. If both svc_location_no and client_svc_location_id are provided, svc_location_no will take precedence.

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.

Defines a transaction type for Credit Cards and Tokenized Credit Cards. If a value is not entered, it will default to your client configuration settings. Please note that the values differ per processor. For a list of transaction types, please read our documentation.

The transaction mode identifies the channel from which the transactions are originated of Cybersource 3ds 2.0.

Use this field to specify how the customer will authorize the mandate for direct debit collection. It is required for ACH, SEPA, and BACS. If the the mandate is collected online, the customer IP address and useragent must be collected and passed in the collection API. If offline, you must collect and maintain the authorization in your records. This is applicable for Stripe Payment Processor.

The type of entity that holds the account. This is applicable for Stripe Payment Processor.

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.

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 pro-rated tax credit amount

The total pro-rated credit amount

The non-tax pro-rated credit amount

This array contains a list of queued plans, their identifier, and type.

See fields below

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

See fields below

Aria queue_id for future plan changes that can be used for follow on actions.

This designates the type of queued action.

Aria plan instance number

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.