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

Alternative required field: new_client_plan_id

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

Alternative required field: new_plan_no

Unique master plan instance client-defined identifier

Billing group number

Alternative field: existing_client_billing_group_id

Client-defined unique identifier for billing group

Alternative field: existing_billing_group_no

Billing Group name

Billing group description

Client-defined unique identifier for billing group

How the client communicates with the account holder. If a notification method is not provided, this value defaults to "1" (HTML email).

Aria-assigned unique identifier for the notification template group to be associated with the billing group.

Alternative field: client_notification_template_group_id

Statement template No.

Credit note template No.

Primary payment method ID

Client-defined unique identifier of the primary payment method

Backup payment method ID

Client-defined unique identifier of the backup payment method

Statement contact first name

The Middle Initial of the statement contact.

Statement contact Last name

Company name of the statement contact

First address line of the statement contact

Second address line of the statement contact. 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 statement contact

City of the statement contact

Use this field instead of the state_prov field to designate the state, province or other local designation as appropriate for addresses in all countries other than the United States, Australia, and Canada. This field is ignored for all United States, Australia and Canada addresses.

State or Province of the billing contact. 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 contact. The ISO-compliant 2-character country code abbreviation in uppercase.

Postal/Zip code for the statement contact address.

The phone number of the statement contact

The extension for the statement contact phone

The contact cell phone of the statement contact.

Work phone number of the statement contact.

The extension for the statement contact work phone

The fax number for the statement contact.

Email of the statement contact

The birthdate, in yyyy-mm-dd format, of the statement contact.

First name of the billing contact.

Middle initial of the billing contact.

Last name of the billing contact.

Company name of the billing contact.

First address line of the billing contact.

Second address line of the billing contact. If you want to delete existing data in this field, leaving it blank, you must enter a '~' in this field.

The third line of the billing address.

City of the billing contact.

Use this field instead of the state_prov field to designate the state, province or other local designation as appropriate for addresses in all countries other than the United States, Australia, and Canada. This field is ignored for all United States, Australia and Canada addresses.

State or Province of the billing contact. 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 billing contact. The ISO-compliant 2-character country code abbreviation in uppercase.

Postal code for the billing contact.

Phone number of the billing contact.

Phone extension of the billing contact.

Cell phone number of the billing contact.

Work phone number of the billing contact.

This is the work phone extension for the billing contact work phone.

Fax number of the billing contact.

Email of the billing contact.

Birthdate of the billing contact.

Payment method name.

Client-defined unique identifier for the payment method.

Payment method description

This is the method_id corresponding to a payment method such as credit card, Electronic Check, Pre-Paid, Net Terms, etc.

Credit card number.

Expiration month for the credit card payment instrument.

Expiration year for the credit card payment instrument.

The bank account number.

The ABA routing number for the bank holding bank_acct_no

Card Verification Value, used to help verify a transaction is being requested by the card holder since this value is physically printed on the credit card.

Raw "track 1" data from a swiped credit card used in a card-present transaction to initiate this request

Raw "track 2" data from a swiped credit card used in a card-present transaction to initiate this request

Unique ID of the bill agreement (also referred to as a token).

International Bank Account Number(IBAN). Used for the Direct Debit payment method. It consists of 16 to 34 alphanumeric characters. Only hyphen and space are allowed to format the IBAN.

Bank check digits enable a sanity check of the bank account number to confirm its integrity before submitting a transaction. Used for the Direct Debit payment method.

SWIFT code is a standard format of Bank Identifier Codes (BIC). It is used for the Direct Debit payment method. It consists of 8 or 11 alphanumeric characters. Only hyphen and space are allowed to format the SWIFT code. It is required for IBAN.

Country of the bank. The ISO-compliant 2-character country code abbreviation in uppercase. Used for the Direct Debit payment method. It is required for IBAN and BBAN.

Used for the Direct Debit payment method. A mandate is signed by the debtor to authorize the creditor to collect a payment and to instruct the bank of the debtor to pay those collections.

Up to 10 digit numeric bank identifier code. Used for the Direct Debit payment method. Only hyphen and space are allowed to format the bank ID code. It is required for BBAN.

Up to 10 digit numeric bank branch code. Used for the Direct Debit payment method. Only hyphen and space are allowed to format the bank branch code.

The dunning group number mapped against each master plan.

Alternative field: existing_client_def_dunning_group_id

The client-defined dunning group ID mapped against each master plan.

Alternative field: existing_dunning_group_no

Name of the dunning group.

Description of the dunning group.

Client-defined dunning group identifier.

Dunning process code.

Alternative field: client_dunning_process_id

Client-defined dunning process identifier.

Alternative field: dunning_process_no

Alternative start date, in yyyy-mm-dd format, for the master plan instance being assigned on the account. This date can be used to delay providing services to the account holder (for example: until they have been email validated), and must be within one billing interval of the plan being assigned.

Status of the master plan instance prior to alt_start_date or alt_bill_day. If the alt_start_date or alt_bill_day field is used, this field is required and defaults to 0 (inactive) if no value is provided. If an alternate starting date or alternate bill day is provided, the master plan instance remains in this status until its start date arrives. This only applies if a prorated invoice is not created. If a prorated invoice is created, this field is ignored.

Number specifying a day of the month to use as an alternate bill day. You can enter a bill date other than the anniversary date in this field. The invoice_mode must be set to 0 or must be blank to enter a date in this field, it cannot be set to 1.

Indicator for performing full invoicing, and Perform Prorated Invoicing or client-defined on this account as part of this call.

Date, in yyyy-mm-dd format, to set for retroactive start.

Applicable only for master plan assignment. When provided, this date will be used as the bill thru date for the master plan instance. The alt_start_date or retroactive_start_date input will be honored with override_bill_thru_date, but invoicing_option must be set to Perform Prorated Invoicing. The override_dates_mp_instance_no or override_dates_client_mp_instance_id parameters take precedence over this input parameter, and if provided together the override_bill_thru_date input will be ignored. The date provided must be in the future, must be after the alt_start_date (if provided), and cannot exceed one recurring billing interval. This parameter cannot be used with alt_bill_day or status_until_alt_start (defaults to Inactive). A prorated invoice will be generated for recurring services from the effective start date of the plan instance through the override_bill_thru_date provided. If the plan being assigned has no usage services, the next_bill_date (aka anniversary date) will be the override_bill_thru_date + 1 day. If the plan has usage services, then the next_bill_date will be calculated based on the usage interval to be the earliest date in the future that will ensure usage and recurring services will be invoiced together on the override_bill_thru_date + 1 day.

Applicable only for master plan assignment. When provided, the billing dates for the new master plan being assigned will be aligned with the billing dates of the existing master plan instance specified (honoring the bill day of the existing master plan instance). The alt_start_date or retroactive_start_date input will be honored with the override_dates_mp_instance_no or the override_dates_client_mp_instance_id, but invoicing_option must be set to Perform Prorated Invoicing. These parameters take precedence over the override_bill_thru_date parameter, and cannot be used with alt_bill_day or status_until_alt_start (defaults to Inactive). If the recurring interval of the new master plan instance will be the same as or longer than the existing master plan instance, a prorated invoice for the master plan being assigned will be generated for recurring services from the effective start date of the plan instance through the bill_thru_date of the existing master plan instance. If the recurring interval of the new master plan instance will be shorter than the existing master plan instance, the bill_thru_date for the new master plan instance will be calculated based on its recurring interval to be the earliest date in the future that will ensure the recurring services for both master plan instances will be invoiced together on the existing master plan instance's bill_thru_date + 1 day. In the above scenarios, if the new master plan instance has no usage services, the next_bill_date (aka anniversary date) will be the bill_thru_date + 1 day. If the new master plan instance has usage services, then the next_bill_date will be calculated based on the usage interval to be the earliest date in the future that will ensure usage and recurring services will be invoiced together on the bill_thru_date + 1 day.

Alternative field: override_dates_client_mp_instance_id

Applicable only for master plan assignment. When provided, the billing dates for the new master plan being assigned will be aligned with the billing dates of the existing master plan instance specified (honoring the bill day of the existing master plan instance). The alt_start_date or retroactive_start_date input will be honored with the override_dates_mp_instance_no or the override_dates_client_mp_instance_id, but invoicing_option must be set to Perform Prorated Invoicing. These parameters take precedence over the override_bill_thru_date parameter, and cannot be used with alt_bill_day or status_until_alt_start (defaults to Inactive). If the recurring interval of the new master plan instance will be the same as or longer than the existing master plan instance, a prorated invoice for the master plan being assigned will be generated for recurring services from the effective start date of the plan instance through the bill_thru_date of the existing master plan instance. If the recurring interval of the new master plan instance will be shorter than the existing master plan instance, the bill_thru_date for the new master plan instance will be calculated based on its recurring interval to be the earliest date in the future that will ensure the recurring services for both master plan instances will be invoiced together on the existing master plan instance's bill_thru_date + 1 day. In the above scenarios, if the new master plan instance has no usage services, the next_bill_date (aka anniversary date) will be the bill_thru_date + 1 day. If the new master plan instance has usage services, then the next_bill_date will be calculated based on the usage interval to be the earliest date in the future that will ensure usage and recurring services will be invoiced together on the bill_thru_date + 1 day.

Alternative field: override_dates_mp_instance_no

balance forward

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

Unique identifier of a plan in the plan instance hierarchy under which the new plan will be assigned.

Alternative field: client_parent_plan_instance_id

Unique Client-defined identifier of a plan in the plan instance hierarchy under which the new plan will be assigned.

Alternative field: parent_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 CSRs 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.

Surcharge for master plan Instance

See fields below

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

For plan recurring intervals of longer than one month, the number of months to offset proration and first bill date.

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.

Automatically set the offset for the billing anniversary month.

One-time collections account group to use for this specific call. Default collections group on the account is not changed.

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

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.

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

Determines when the NSO order is fulfilled and then billed.

Non-Subscription Offerings that are purchased with the 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.

Purchase order number assigned to the one-time order.

A numeric code indicating the type of credit card.

The Aria-assigned unique identifier for the contact on this account to be used as the billing contact for the payment method. If bill_contact_no is included in the API request, all other billing contact parameters are ignored.

The Aria-assigned unique identifier for the statement contact associated with a billing group on the account.

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

See fields below

Indicator for combining invoices when retroactive start dates, negative bill lag days, or plan changes just prior to the next billing date would otherwise have generated multiple invoices. The allowable values are 1, 2, or 3.

Credit template No.

Rebill template No.

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.

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.

Array for collection groups for billing group.

See fields below

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.

Client-defined unique identifier for the notification template group to be associated with the billing group.

Alternative field: notify_template_group

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

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. Note: The resp_master_plan_instance_no will be ignored when the resp_level_cd is "self-pay".

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. Note: The resp_client_master_plan_instance_id will be ignored when the resp_level_cd is "self-pay".

Alternative field: resp_master_plan_instance_no

Applicable only for plan instance that is of daily/weekly billing interval type. It is for supplemental plan only in assigning and for both master plan and supplemental plan in replacing. The date, in yyyy-mm-dd format, should never be before the alt_proration_start_date if specified, the retroactive_start_date if specified, or the current date.

Bank name for the account payment method

Bank city for the account payment method

Client-defined account identifier.

Alternative required field: acct_no

An array of coupon details which will be assigned at MPI stack level or to specific PI based on the assignment_scope.

See fields below

The date the Non Subscription Offering is fulfilled. A date in the past, present, or future can be specified.

The type of bank account being used.

This field denotes the bank account holder type. The value can be either individual or company.

The date, in yyyy-mm-dd format, on which the mandate was signed.

A unique ID number defined in a taxation provider (like Avalara) to identify your different company's or business units.

The code provided by the account validator.

This is the electronic signature returned after successfully completing an e-mandate request through an e-Mandate service.

Array of e-invoicing fields associated with the billing group.

See fields below

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

The surcharge number to assign to the master plan. Required when assigning a surcharge to a master plan.

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

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

NSO quantity that is purchased along with plan

The Aria-assigned unique identifier for the origin location for the item (NSO) being purchased. 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 item (NSO) being purchased. 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 item (NSO) being purchased. Depending on taxation configuration, this address may be used for tax calculations.

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.

Collection Group Number to which this billing group should be assigned.

Alternative field: client_collections_group_bg_id

Collection Group ID to which this billing group should be assigned.

Alternative field: collections_group_bg_no

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 unique catalog service no.

CLient defined service identifier.

Aria unique catalog plan no.

Client defined plan identifier.

List of services under the plan no.

See fields below

Aria unique item no.

Client defined item id.

Discount rule no associated to the coupon.

Client defined rule id associated to the coupon.

Override scope number

Array of plans which can be overridden. For scope_no 11, only plan_no information will be considered and service_detail will be ignored. For scope_no 12, only service_details will be considered. plan_no, client_plan_Id will be ignored. For scope_no 13, both plan_no detail and service_detail will be considered and validated. For all other scopes, thie plan_details will be ignored.

See fields below

Array of plans which can be overridden. Supply the array for scope_no 31.

See fields below

The coupon codes to assign at MPI stack level or to specific PI based on the assignment_scope.

Determines whether the coupon should be assigned at MPI stack level, or to the PI passed as input or if it is also to be assigned to the mandatory child plans of the PI.

This field overrides the discount rule scope set at "Marketing Catalog".

See fields below

Name of the e-invoicing field.

The value corresponding to the e-invoicing field name.

Aria-assigned error identifier. 0 indicates no error.

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

The unique identifier of the plan instance (can be either a master or supplemental plan) on which the plan will be replaced.

The unique identifier for an order that is created for bundled NSOs.

Status label for this order

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

See fields below

Collection group and processor details when there is a cc auth or validation failure.

See fields below

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

See fields below

The payment method sequence no for the payment attempted during collection.

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

Collection Group number.

Collection Group Name.

Payment Processor Id.

Payment Processor Name.

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.