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

This is an array of line items appearing on the order. The array elements for this argument immediately follow and are indicated as elements with a right-arrow icon.

See fields below

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.

Unique plan instance number for each assigned supplemental plan.

Client-defined plan instance ID for each assigned supplemental plan.

The Aria-assigned identifier for a supplemental service plan. Allowable values are limited to valid custom plan numbers for client.

Client-defined supplemental plan ID.

Number of units for the supplemental plan

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.

Determines when the order is fulfilled and then billed. If no value is defined (the field is null), then billing timing is determined by the client parameter AUTO BILL ORDERS. Contact Customer Support for more information about the AUTO BILL ORDERS parameter.

The billing sequence number

This is the client-assigned order identifier.

Client-defined unique identifier used to track related system actions

If you want to use the account's current form of payment, leave this field empty. If you want to use an alternate credit card, enter '1' in this field.

Credit card number.

Expiration month for the credit card payment instrument.

Expiration year for the credit card payment instrument.

The American Banking Association (ABA) routing number for the financial institution.

The bank account number.

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.

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.

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.

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.

Company name of the billing contact.

First name of the billing contact.

Middle initial of the billing contact.

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

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.

Zip Code of the billing contact

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

Email of 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.

Work phone extenstion of the billing contact

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.

The type of bank account being used.

Drivers license number of the billing contact

Drivers license state of the billing contact. The official postal-service codes for all United States and Canada states, provinces, and territories.

Taxpayer ID of the billing contact

The third line of the billing address.

See fields below

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

The client alternate invoice template number to use for this order, if different from the default template

Alternative field: alt_inv_template_no

The invoice template number to use for this order, if different from the default template

Alternative field: client_alt_inv_template_id

Alternate contact details for orders.

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

Transaction description shown on the buyer's statement that displays a Merchant Name or Item Description typically. This field will be ignored if not supported/certified by the payment processor.

Transaction description shown on the buyer's statement that displays a City for Card Present transactions or a Phone Number for Card Not Present transactions. This field will be ignored if not supported/certified by the payment processor.

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'

Comments for this order

Purchase order number assigned to the one-time order.

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

List of contacts to be created on the account. Note that contacts not used as an account contact, billing contact, or statement contact will be saved on the account.

See fields below

Sends the CVV value of the current credit card on file.

Enable Fraud Filtering. This is supported if your payment processor supports this feature and has been certified with Aria. If no values are provided, the system will default to 2.

List of key-value pair parameters to control Fraud Control.

See fields below

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.

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

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

Bank name for the account payment method

Bank city for the account payment method

Date on which order is fulfilled.

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

Array of additional values you can associate with each order.

See fields below

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

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.

Name of the field you want to associate with order line item

Corresponding value of the field you want to associate with order line item

The number of units indicated for this SKU on the line item.

The amount for this line item.

Any client-defined comments, from a CSR or automated system, for this particular line item. Note: The field size limit is less than 3000 characters or 4000 bytes.

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

For non-persistent referencing of a destination contact in the contacts array within the API request. Depending on taxation configuration, the address associated with this destination contact may be used for tax calculations.

Aria-assigned unique identifier for the rate schedule.

Alternative field: client_nso_rate_schedule_id

Client-defined unique identifier for the rate schedule.

Alternative field: nso_rate_schedule_no

Client-defined unique identifier for order line item.

Array of additional values you can associate with each order line item

See fields below

Installment no on product catalog. If null, then it selects installment default.

Alternative field: client_installment_term_id

Specifies client installment id. If null, then it selects the installment default.

Alternative field: installment_term_no

Defines the start date of independent installment, needs to be the same or greater than the current date. If passed, the associated "days_to_start" and "lump_sum_days" value will be ignored.

Specifies the individual installment amount, inclusive of tax. For example, if a purchase is taxed at 15%, a $20 installment amount will be split into $17.39 (charge) and $2.61 (tax). The total tax-inclusive purchase amount will be divided by this amount to calculate the length of installment. Note: If this field is provided, the installment_term_length field will be ignored.

Specifies installment type for the account, whether installment should be aligned with master plan instance or independent. Allowable values are: Yes (Y) - Aligned with existing master plan instance OR No (N) - Independent, its own installment schedule and due dates.

Specifies the installment term type for the assigned installment, applicable only for independent. Allowable values are: M (Months), W (Weeks), D (Days).

Specifies the installment term length for the assigned installment. For installment_type = 2, the input will be used jointly with the interval type. For installment_type = 1, this will be the number of statements that the installment amount will be part of.

Specifies the installment interval for the assigned installment, applicable only for independent installment. It works jointly with terms type. If defined, must be less than terms length.

Specifies the number of days until due for the independent installment. Applicable only when installment_type = 2 or installment term defined on product catalog is aligned_installment =N. Determines how many days after customer is notified on the installment that it's due. If 5 is passed, then 5 days after customers are notified, the installment will be due.

Specifies the installment lump sum type for the assigned installment. Allowable values are: P - for proportionately split charge/tax; T - for purchase tax only.

Specifies the lump sum amount, mandatory when lump sump type is proportionately split (lump_sum_type = P).

Applicable only for aligned installment. Determines when to notify customers of the lump sum. Allowable values are: 0 - Aligned with when an invoice is created; 1 - Aligned with the 1st installment

Specifies the lump sum days. Applicable only for independent installment (update_installment_type = 2 or installment term defined on product catalog is aligned_installment = N). Determines how many days after a purchase or invoice date that a lump sum is charged and be notified to customers.

Specifies the lump sum days until due, applicable for both types of installment. Determines how many days after customers are notified that a lump sum is due.

Specifies the percentage used to calculate the allowable additional amount for the last installment's threshold. For example: If the installment amount is $50 and the remainder is $80, with 0%, the remainder is split into $50 and $30 (last installment). With 90%, the allowable additional amount is $45, making the last installment threshold $95. In this case, the last installment amount will be $80. If set to NULL, it defaults to 0%. Valid values are 0 to 99.

associate multiple coupons.

Determines whether the coupon code is to be assigned to the parent_plan_instance_no (MP) or the supp_plan_instance_no/supp_plan_no passed as input.

Determines whether the coupon is to be assigned to a specific plan instance passed as input or if it also to be assigned to the mandatory child plans for the supp_plan_no assignment.

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

For non-persistent referencing of a destination contact in the contacts array within the API request. Depending on taxation configuration, the address associated with this destination contact may be used for tax calculations. If both dest_contact_idx and dest_contact_no are provided, dest_contact_no will take precedence.

A caller-defined numeric value is required if you wish to add a new contact as an account contact, billing contact, statement contact, or destination contact. This value can then be used to reference this new contact within the context of this API request (and is not stored in Aria).

The first name of the contact.

The middle initial of the contact.

The last name of the contact.

The company name of the contact.

The first address line of the contact.

The second address line of the contact.

The third address line of the contact.

The city of the 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.

The state or province of the contact. Note that only the official postal-service codes for states, provinces, and territories in the United States, Australia and Canada are supported. Use the other_locality field for states, provinces, or territories in other countries.

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

The postal/zip code of the contact.

The phone number of the contact.

The phone number extension of the contact.

The cell phone number of the contact.

The work phone number of the contact.

The work phone number extension of the contact.

The fax number of the contact.

The email address of the contact.

Birthdate of the contact in yyyy-mm-dd format.

List of Fraud Control field names.

List of Fraud Control field values.

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.

Name of the field you want to associate with order.

Corresponding value of the field you want to associate with order.

Aria-assigned error identifier. 0 indicates no error.

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

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

The error message associated with collection_error_code.

The unique identifier for an order in the context of an client_no and account_no.

The Aria-assigned unique identifier of a given invoice.

The text message associated with 'invoicing_error_code'

The error code generated by Aria when Aria attempted to generate a statement

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.

See fields below

Errors from third-party systems like taxation engines are returned here. Aria-generated error codes are returned in the error_code and error_msg fields at the root level of the API return.

See fields below

Fraud Filtering Response returned from Payment processor.

See fields below

The error code generated by Aria when Aria attempted to generate a invoice

Total charges on this invoice before taxes are applied

Total amount of taxes charged

Subtotal combining the total pre-tax charges and the total taxes charged

Sum of all the credits on the invoice

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

See fields below

Errors that occurred while performing Threshold Billing and related calculations

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.

Installment schedule info array.

See fields below

The invoice line number associated with the current record.

Aria-assigned unique service identifier

The name corresponding to this line item's service code.

A boolean value indicating the service is actually a tax. (true/1=yes, false/0=no)

Number of units for the specified invoice line.

The monetary rate per unit of service.

The total line amount for this invoice line.

Description of the invoice line item.

The starting date range for the item or plan on this line

If any, the ending date range for the item or plan on this line.

The usage type of the usage units specified.

The plan number associated with the usage asserted in this invoice.

The name of the plan for the specified plan_no.

Client-defined service identifier.

The usage type code of the usage type specified.

Client-defined Plan ID associated with the usage asserted in this invoice.

The reference charge line number to indicate the item to which the discount applies.

Purchase order number assigned to the plan instance.

Address sent as the bill-from address to the tax engine for tax calculations. Depending on the taxation configuration, this parameter may return the Aria-assigned unique identifier of the service location for the invoice line item. Note that service locations can be associated with a service for a given plan instance on an account, with an item (NSO) purchased as part of a one-time order, or with a service as defined in the product catalog.

Address sent as the ship-from address to the tax engine for tax calculations. Depending on the taxation configuration, this parameter may return the Aria-assigned unique identifier of the service location for the invoice line item. Note that service locations can be associated with a service for a given plan instance on an account, with an item (NSO) purchased as part of a one-time order, or with a service as defined in the product catalog.

Address sent as the bill-to address to the tax engine for tax calculations. This parameter will return the Aria-assigned unique identifier of the contact on the account used as the bill-to address for the invoice line item.

Address sent as the ship-to address to the tax engine for tax calculations. This parameter will return the Aria-assigned unique identifier of the contact on the account used as the ship-to address for the invoice line item.

Aria-assigned unique identifier for the rate schedule used to price this NSO.

Client-defined unique identifier for the rate schedule used to price this NSO.

Tier number of this rate schedule.

Specifies the type of charge or credit associated with this line item.

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. Please note that there are cases in which the custom_rate_ind is null/0 but rate_schedule_no is also null. These special cases include rebill rate changes and multi-plan contract early cancellation fees where the charges are neither from regular rate schedule nor from custom rates. Another such case is the dummy zero amount line formed when net usage is negative for a usage service.

Aria assigned installment term no

Aria assigned installment schedule no

Aria-assigned error identifier. 0 indicates no error.

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

Fraud country status provided by the Payment processor.

Fraud country code provided by the Payment processor.

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

Aria-assigned error identifier. 0 indicates no error.

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

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.

Aria assigned installment schedule no.

Aria assigned seq schedule no.

Dates when customer will be notified of an installment.

Due dates of when individual installment is due.

Amount due of each individual installment.