Aria-assigned unique identifier indicating the Aria client providing service to this account.

Client-defined unique identifier used to track related system actions

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

This is the client-assigned identifier for the account.

Alternative required field: acct_no

The user's unique identifier. Every account must have an associated user ID.

Password for the given user

The user's secret question recorded to recover a password.

The response to a user's secret_question

Persinal Identification number

For non-persistent referencing of a contact in the contacts array within the API request. If an idx value is specified, inputs provided for other account contact fields are ignored.

The Aria-assigned unique identifier for the account contact saved on the account.

Contact First name

The Middle Initial of the contact.

Contact last name

Company name of the contact

First address line of the 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.

Third 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 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 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 as the ISO-compliant 2-character country code abbreviation in uppercase. If you enter contact address information, but leave this field blank, then this field defaults to "US". If no contact address information is entered, this field remains blank.

Postal/Zip code for the contact address.

The phone number of the contact

The extension for the contact phone

The contact cell phone.

Work phone number of the contact.

The extension for the contact work phone

The FAX phone number for the contact.

Email of the contact

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

The status to which you are setting this account.

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

The senior_acct_no is the unique account number for the parent account and is used to establish parent-child billing relationships. To remove a parent account from a child account, you must enter '-999' in this field.

User ID of the parent account

Client-account ID of the parent account

Indicates that the account is a test account and is treated as such in the system. The default value is 0.

Taxpayer Identification number.

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

An array of coupon details for the account.

See fields below

Date, in yyyy-mm-dd format, on which the account was first created outside of Aria

Functional account group number specifically designated for statement sequence number assignment.

Alternative field: client_seq_func_group_id

Client-defined functional account group number specifically designated for statement sequence number assignment.

Alternative field: seq_func_group_no

Provides the Tax Exemption Level for the account. This field only applies to the Aria internal tax engine.

If 'true', resets the billing dates after an account status change.

New Client-defined account ID for updating existing Client-defined account ID.

Indicator for performing full invoicing, prorated invoicing or client-defined on this account as part of this call.

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

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.

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

Array of functional groups to update.

See fields below

Array of account collection groups to update

See fields below

Array of objects to be updated. Each object contains a list of values for one of the following fields: acct_supp_field_name, acct_supp_field_value, or acct_supp_field_directive. The first value in each object is automatically associated with the first values in the other objects, as are the second values, third values and so on. Each object must contain the same number of values, or the API fails.

See fields below

See fields below

Client-defined unique identifier for Master plan instance

The Master Subscription plan instance number.

New Client-defined master plan instance ID for updating existing Client-defined master plan instance ID.

Client-defined unique identifier for Master plan

Master plan number

Master plan instance description

Dunning group to assign to master plan instance

Client-defined unique identifier of dunning group to assign to master plan instance

Billing group to assign to master plan instance. Note that, if the account that is passed in the input is being converted into child account in this API call, then the billing group number passed in this input will be ignored since it will be driven off of the parent account.

Client-defined unique identifier of billing group to assign to master plan

Master plan instance status

This is multiplier variable for the recurring rate on the plan. Generally this value is 1, indicating the face value of the plan's recurring fee is used.

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

The alternate rate schedule number for the master subscription plan being considered.

Alternative field: client_alt_rate_schedule_id

The client-defined unique alternate rate schedule identifier for the master plan

Alternative field: alt_rate_schedule_no

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.

An array of coupon details for the master plan instance.

See fields below

The scope rule to be applied to this assignment/de-assignment request, governing both the date upon which the assignment should take place (immediately or on the account's anniversary date) and the proration rule that should be applied (per client's default rules for proration on plan assignment v. forcing proration on or off for this request only). Default behavior is to assign plan to account on the account's anniversary date, resulting in no proration effect.

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.

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.

Specifies whether to invoice the unbilled usage if a plan is terminated in the middle of a billing period.

Boolean indicator to override client's default configured behaviour for creating Pending/Real invoice.

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

See fields below

Surcharge for master plan

See fields below

See fields below

See fields below

See fields below

Profile ID of an existing Revenue Recognition Profile.

Alternative field: client_revrec_id

Client-defined identifier of an existing Revenue Recognition Profile. If this parameter is specified it will take precedence over revrec_profile_no.

Alternative field: revrec_profile_no

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

: Purchase order number assigned to a master plan instance.

Indicates whether the account is listed at the start of a master file.

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

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

Aria-assigned legal entity identification number. You can only update this field if the account has not yet been assigned to a legal entity, and if legal entities are enabled for this client.

Alternative field: client_legal_entity_id

Client-assigned unique identifier for the legal entity.

Alternative field: legal_entity_no

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

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

An array containing the list of additional cc email addresses

An array containing the list of additional bcc email addresses

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.

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

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.

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 for assigning email templates to the account. Overrides legacy template fields.

See fields below

Array of e-invoicing fields associated with the account.

See fields below

The coupon codes to assign to this account, if any

Array of functional account groups.

Alternative field: client_functional_acct_group_id

Array of functional account group IDs to which this account should be assigned

Alternative field: functional_acct_group_no

For each functional group, this specifies what action to take

Array of collections account groups.

Alternative field: client_collections_acct_group_id

Array of collections account group IDs to which this account should be assigned

Alternative field: collections_acct_group_no

Whether to add or remove the account to or from the specified groups

Pipe-delimited array of supplemental field names. This value is required if you want to assign supplemental fields. For example, if you have any accounts that are tax-exempt or international, you must set up corresponding account supplemental fields prior to your tax provider configuration. Create fields for the tax exemption number and for the VAT ID used by the tax provider.

Pipe-delimited array of supplemental field values.

Pipe-delimited array of account supplemental field directives. Specifies what actions to take (update, delete, etc.)

The Surcharge number to be attached to the account

The surcharge directive to assign/remove the surcharge from the account

The Schedule number for this surcharge

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

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.

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

The value of the product field. Values for product fields that do not match what is expected based on product field configuration will be ignored.

Required for each plan instance field provided.

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

The unique identifier for the service no, relative to the value provided in corresponding "custom_rate_plan_no", to which this custom rate is to be applied for this account.

The rate tier number, relative to the values provided in corresponding "custom_rate_plan_no" and "custom_rate_service_no", to which this custom rate is to be applied for this account.

The unit starting point, relative to the values provided in corresponding "custom_rate_plan_no", "custom_rate_service_no" and "custom_rate_seq_no", to which this custom rate is to be applied for this account.

The unit ending point, relative to the values provided in corresponding "custom_rate_plan_no", "custom_rate_service_no" and "custom_rate_seq_no", to which this custom rate is to be applied for this account.

The custom rate per unit, relative to the values provided in corresponding "custom_rate_plan_no", "custom_rate_service_no" and "custom_rate_seq_no", to be applied for this account.

The unique identifier by client the service ID to determine which custom rate is to be applied for this account.

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

Whether to add or remove the collection group to or from the specified billing group.

Name of the e-invoicing field.

The value corresponding to the e-invoicing field name. Required when bg_einvoicing_field_directive is 1 (save); ignored when it is 2 (delete).

Action for this entry. Defaults to 1 (save) when omitted.

Billing Group name

Billing group description

Billing group number

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

Credit note template No.

This allows you to select either payment methods (such as a credit card or other electronic form of payment) or payment terms (such as a physical check) when creating or modifying a billing group'

Unique identifier associated with an existing payment method for the specified account to be used as the primary payment method on the billing group

Client-defined unique identifier of the primary payment method

Unique identifier associated with an existing payment method for the specified account to be used as the backup payment method on the billing group.

Client-defined unique identifier of the backup payment method. The payment method specified must be the same as the primary payment method.

For non-persistent referencing of a contact in the contacts array within the API request. If an idx value is specified, inputs provided for other account contact fields will be ignored.

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

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.

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

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.

Indicates whether the account is listed at the start of a master file.

Payment terms number assigned to the account.

Payment terms name assigned to the account.

Client-defined identifier for the billing group's payment term

'This is the European Article Number or Global Location Number that is a required field if a payment option is terms AND one of the input parameters payment terms number/payment terms name/ client payment term ID matches a term in which the payment term type equals EAN/GLN. This number should be provided by Aria's clients' customers and is unique to each customer (account).'

'This is the European Article Number requisition number or Global Location Number requisition number that is a required field if a payment option is terms AND one of the input parameters payment terms number/payment terms name/client payment term ID matches a term in which the payment term type equals EAN/GLN. This number should be provided by Aria's client's customers and is used to track their individual projects similarly to a purchase order. This number is generated by the individual customer (account) and is not provided by any other party'

Credit template No.

Rebill template No.

Update Array for collection groups for billing group.

See fields below

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

Alternative field: notify_template_group

Indicates what operation to perform on each billing group specified. No default value for this parameter.

The client-defined identifier of the billing group.

Unique client-defined identifier of the billing group. If provided for an existing billing group, this value will overwrite the existing client-defined ID for that billing group.

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

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

See fields below

Aria-assigned sequence number for this payment method.

For non-persistent referencing of a contact in the contacts array within the API request. If an idx value is specified, inputs provided for other account contact fields will be ignored.

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.

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.

Human-readable name of the payment method

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, 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 American Banking Association (ABA) routing number for the financial institution.

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.

If 'true', a collection is attempted after updating electronic billing information on accounts with outstanding balances.

Indicates whether the mpi status has to change after collection is completed.

A numeric code indicating the type of credit card.

Bank name for the account payment method

Bank city for the account payment method

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.

Indicates what operation to perform on each payment method specified. No default value for this parameter.

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.

The Aria-assigned address sequence number.

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.

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

The city of the contact.

The locality of the contact.

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.

The birthdate of the contact.

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.

Email Template Class is the category of email templates to choose from. If it is given NULL, we will consider 'I' as default.

Email template number to use for this account.

Alternative field: client_template_id

Client-defined email template ID to use for this account.

Alternative field: template_no

Name of the e-invoicing field.

The value corresponding to the e-invoicing field name. Required when acct_einvoicing_field_directive is 1 (save); ignored when it is 2 (delete).

Action for this entry. Defaults to 1 (save) when omitted.

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 result of the synchronization of the parent/child billing dates (if attempted).

The corresponding text error message for the parent_child_sync_error_code value.

Error code returned upon failure when attempting to update the master plan

Human-readable error message corresponding to master_plan_error_code

Error code for master plan collection errors.

Human-readable error text corresponding to the master_plan_coll_error_code

Error code returned upon failure to update the master plan statement

Human-readable error message corresponding to master_plan_stmt_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.

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

Master plan instance number

Client-defined unique identifier for Master plan instance

Master plan number

Client-defined unique identifier for Master plan

Master plan instance description

Master plan proration total amount

Master plan proration amount

Master plan proration tax amount

Master plan proration surcharge amount

Master plan prorration credit amount

Supplemental plan instance number

Client-defined unique identifier for supplemental plan instance

Supplemental plan proration amount

Supplemental plan proration tax amount

Supplemental plan proration surcharge amount

Supplemental plan proration credit amount

The unique identifier of a given invoice.

Billing group number

Client-defined unique identifier for billing group

Name of the account level locale.

List of billing contacts saved on the account.

See fields below

List of statement contacts saved on the account.

See fields below

List of contacts saved on the account that are not used as an account, billing, or statement contact.

See fields below

Fraud Filtering Response returned from Payment processor.

See fields below

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

The Aria-assigned unique identifier for the account contact saved on the account.

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

Information of the Chief account in the account hierarchy.

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.

The type of error code being represented, such as taxation

The error code returned by the third party system

The error message returned by the third party system

Aria-assigned sequence number for this payment method.

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 billing group on the account.

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

The Aria-assigned unique identifier for the contact saved on the account.

Value provided for the idx parameter in the API request.

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

Collection Group number.

Collection Group Name.

Payment Processor Id.

Payment Processor Name.

Aria-assigned account identifier. This is the Chief of all accounts in hierarchy.

The User ID of the Chief account in account hierarchy.

Client-assigned identifier for the Chief account in account hierarchy.

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.