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.

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

Defines all information about the top-level account, including contact information, assigned client plans, and payment configuration

See fields below

The Aria-assigned identifier of the functional account group in which to place this account. A functional account group allows you to categorize your customers based on some common element such as geography, product, or channel.

Alternative field: client_functional_acct_group_id

Client-defined functional account group ID to which to assign this account

Alternative field: functional_acct_group_no

If you created a collections group for a specific payment gateway, be sure to add the account to that collections group during the account registration process or soon afterward. This ensures that collections for accounts in that collections group are completed successfully.

Alternative field: client_collections_acct_group_id

Client-defined collections account group ID to assign to this account

Alternative field: collections_acct_group_no

Name of the supplemental field. 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.

The value for the supplemental field name given in supp_field_name

Surcharge number to be attached to the account

Alternative field: client_surcharge_id

Note that only those surcharges with Surcharge Applicablity Scope of Account or Account and Master Plan Instance should be accepted.

Alternative field: acct_surcharge_no

Coupon codes to assign to this account, if any

ID corresponding to a payment method such as credit card, electronic check, prepaid, etc. You must specify a payment method when creating billing information.

Human-readable name of the payment method

Description for the plan method

System-defined statement payment method ID

For non-persistent referencing of a payment method within the API request

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.

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 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 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 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 as the ISO-compliant 2-character country code abbreviation in uppercase.

Postal/Zip code for the billing contact's address

Phone number for the billing contact

Extension for the billing contact's phone number

Cell phone number for the billing contact

Work phone for the billing contact.

Extension for the billing contact's work phone

Fax phone number for the billing contact

Email for the billing contact

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

Credit card number

Expiration month for the credit card payment instrument

Expiration year for the credit card payment instrument

Bank account number of the account holder's payment method. Together with the (ABA) bank_routing_no, this value is used to execute electronic check or ACH transactions.

ABA (American Banking Association) unique identifier for the financial institution

Card Verification Value, used to 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

Taxpayer identification number

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 hyphens and spaces 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.

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.

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.

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

Name of the e-invoicing field.

The value corresponding to the e-invoicing field name.

Billing group name.

Billing group description.

Client-defined billing group ID. This value must be unique across all client accounts. This field can also be used as a reference to assign this billing group to one or more master plan instances within this API request. Either the client_billing_group_id or billing_group_idx must be defined if the billing group is used by one or more master plans within the API request.

Non-persistent billing group identifier. This numeric identifier (1 for the first billing group, 2 for the second, and etc.) allows the billing group to be assigned to one or more Master Plan Instances within this API request. Either the client_billing_group_id or billing_group_idx must be defined if the billing group is used by one or more master plans within the API request.

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 number

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'

Client-defined identifier for the billing group's primary payment method.

Alternative field: primary_payment_method_idx

Non-persistent identifier for the billing group's primary payment method.

Alternative field: primary_client_payment_method_id

Client-defined identifier for the billing group's backup payment method.

Alternative field: backup_payment_method_idx

Non-persistent identifier for the billing group's backup payment method.

Alternative field: backup_client_payment_method_id

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.

First name of the statement contact

Middle initial of the statement contact

Last name of the statement contact

Company name of the statement contact

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

The third line of the address

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 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 statement contact. The ISO-compliant 2-character country code abbreviation in uppercase.

Postal/Zip code for the statement contact's address

Phone number of the statement contact

Extension for the statement contact's phone number.

Cell phone number of the statement contact

Work phone number of the statement contact

Extension for the statement contact's work phone.

Fax phone number for the statement contact

Email for the statement contact

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

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.

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

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

Name of the dunning group

Description of the dunning group

Client-defined dunning group ID. This value must be unique across all client accounts. This field can also be used as a reference to assign this dunning group to one or more master plan instances within this API request. Either the client_dunning_group_id or dunning_group_idx must be defined if the dunning group is used by one or more master plans within the API request.

Non-persistent dunning group identifier. This numeric identifier (1 for the first dunning group, 2 for the second, and etc.) allows the dunning group to be assigned to one or more Master Plan Instances within this API request. Either the client_dunning_group_id or dunning_group_idx must be defined if the dunning group is used by one or more master plans within the API request.

Dunning process.

Alternative field: client_dunning_process_id

Client-defined dunning process identifier.

Alternative field: dunning_process_no

If you enter a value in this field, the contract you specify in the client_contract_id field is applied to the plan(s) you specify here. Otherwise, the contract is assigned at the account level.

Alternative field: client_plan_instance_id

Client-defined plan instance to be associated with the contract

Alternative field: plan_instance_idx

Determines whether to include all child plan instances of the plan instance specified at the time of contract assignment in the contract

Client-assigned unique contract identifier

Type ID of this contract. Placing a value in this field indicates that you are assigning a contract to this account.

Fee charged to the account for prematurely ending this contract

Any client-defined comments stored on this contract at the account level

Date, in yyyy-mm-dd format, on which this contract takes effect. If contract_length_months is blank, and this field is blank, but client_contract_id is specified, then the start date for the contract defaults to today's date.

Date, in YYYY-MM-DD format, on which this contract ends. If the contract_length_months field is valued, this field must be blank. If the contract_start_date field has a value, and the contract_length_months field is blank, then this field must have a value that falls after the value in the contract_start_date field.

Alternative field: duration_length

Indicator which determines whether the contract duration in length is based on months, weeks or days.

The contract duration in length that the given contract will be in effect from the start date.

Alternative field: contract_end_date

Indicator which determines whether the contract renewal duration in length is based on months, weeks or days.

The contract renewal duration in length that the given contract will be in effect from the renewal start date.

Alternative field: renewal_end_date

Date on which the renewal contract ends. Date format is YYYY-MM-DD. For the new contract type '9-Renew contract with different duration', it is mandatory to pass the either the renewal_end_date or the renewal_duration_type and renewal_duration_length. If both are passed, renewal_duration_length will take the precedence over the renewal_end_date.

Alternative field: renewal_duration_length

List of plan instance(s) to be associated with the contract.

See fields below

Specifies the Aria-assigned unique service identifier against which fulfillment details must be captured and stored.

Alternative field: client_service_id

Client-assigned identifier for the service (only for fulfillment based service)

Alternative field: service_no

Fulfilment completion date. Can be a past, current or future date. This field is required if the fulfillment_directive field is set to "2".

Derives whether the fulfillment date is assigned/modified or removed from the fulfillment based service on the plan unit instance

Field name of plan unit instance field. Entering a value in this field creates a field if it does not exist, or assigns it if it does exist.

Value stored under this field

Directive is mandatory if field name/value pair are specified

Client-assigned identifier for the plan unit instance. If valued, creates a plan unit instance for the plan you are assigning to this account.

Array of plan unit instance services

See fields below

Array of client-defined plan unit instance fields

See fields below

Coupon codes to assign to this plan instance, if any

Multidimensional array of services for this plan

Alternative field: client_service_id

Multidimensional array of client-defined service ID for this plan

Alternative field: service_no

Aria-assigned unique location identifier

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 takes precedence.

The Aria-assigned address sequence number

Client SKU of NSO/Inventory item. Entering a value in this field includes this SKU in the order being created.

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 takes precedence.

Client-defined unique identifier for the origin location for the item (NSO) being purchased

Aria-assigned address sequence number

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.

Alternative field: installment_term_length

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.

Alternative field: installment_amount

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

Product field number

Alternative field: field_name

Product field name

Alternative field: field_no

Value of the product field. Values for product fields that do not match what is expected based on product field configuration are ignored.

Aria-assigned identifier for the service. Entering a value in this field creates a custom rate for the plan instance you are assigning to the account.

Alternative field: custom_rate_client_service_id

Client-defined identifier for the service

Alternative field: custom_rate_service_no

Rate tier number, relative to the specified service, to which this custom rate is applied. This field is required if you are creating a custom rate for this plan instance.

Unit starting point for the specified rate tier number

Unit-end point for the specified rate tier number

Custom rate per unit for the specified service and rate tier number

A multidimensional array of Services for this plan

Alternative field: client_service_id

Multidimensional array of client-defined service ID for this plan

Alternative field: service_no

Aria-assigned unique location identifier.

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 takes precedence.

Aria-assigned address sequence number

Specifies the Aria-assigned unique service identifier against which fulfillment details must be captured and stored. You must enter a value in this field if you are creating a plan_unit_instance for a supplemental plan.

Alternative field: client_service_id

Client-assigned identifier for the service (only for fulfillment based service)

Alternative field: service_no

Fulfillment completion date. Can be in past, today or future date.

Derives whether the fulfillment date is assigned/modified or removed from the fulfillment based service on the plan unit instance.

Field name of plan unit instance field. Entering a value in this field creates a supplemental field for the plan unit instance.

The value stored under this field

Directive is mandatory if field name/value pair are specified.

Client-assigned identifier for the plan unit instance. Entering a value in this field is required if you are creating a plan unit instance for a supplemental plan.

Array of plan unit instance services

See fields below

Array of client-defined plan unit instance fields

See fields below

Client SKU of the NSO/Inventory item. Entering a value in this field includes the item in the order being created.

NSO quantity that is purchased along with plan

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 takes precedence.

Client-defined unique identifier for the origin location for the item (NSO) being purchased

Aria-assigned address sequence number

Product field number. Entering a value in this field creates a plan instance field for the supplemental plan.

Alternative field: field_name

Field name of plan unit instance field. Entering a value in this field creates a field if it does not exist, or assigns it if it does exist.

Alternative field: field_no

Value of the product field. Values for product fields that do not match what is expected based on product field configuration are ignored.

Aria-assigned identifier for the service. Entering a value in this field is required to create custom rates for the associated plan.

Alternative field: custom_rate_client_service_id

Client-defined identifier for the service.

Alternative field: custom_rate_service_no

Rate tier number, relative to the specified service, to which this custom rate is applied. Entering a value in this field is required to create custom rates for the associated plan.

Unit starting point for the specified rate tier number

Unit ending point for the specified rate tier number

Custom rate per unit for the specified service and rate tier number

Coupon code to assign to this plan instance, if any.

Determines whether coupon is for a specific plan instance or also to support mandatory child plans. Note: This is valid only if the auto_assign_mandatory_supp_plans parameter is set to "True". If the user provides a mandatory supplemental plan as input while this flag is "False", they must explicitly include the corresponding plan instance coupon in the request. If no coupon is provided for the specific plan instance, no coupon will be assigned to that instance.

Supplemental plan instances assigned under another supplemental plan instance. This contains the same set of fields as the supplemental plan instances located directly under a master plan instance. This supports the creation of a master/supplemental plan structure, with a top-level master plan instance containing a hierarchy of supplemental plan instances.

Aria-assigned identifier for a supplemental service plan. Allowable values are limited to valid custom plan numbers for a client. Entering a value in this field assigns a supplemental plan to a master plan instance on an account.

Alternative field: client_plan_id

Client-defined supplemental plan ID

Alternative field: plan_no

Description for each assigned master plan

Unique client-defined ID for each assigned master plan

Used for non-persistent referencing of a plan instance within the API request. Entering a value in this field is required to map the supplemental plan to its parent plan instance.

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.

List of services associated with the master plan being assigned on the account

See fields below

Array of plan unit instances

See fields below

Non-Subscription offerings that are purchased with the plan

See fields below

See fields below

Aria-assigned identifier for an alternative rate schedule that is assigned to the supplemental plan in place of the default rate schedule

Alternative field: client_alt_rate_schedule_id

Client-defined alternate rate schedule ID

Alternative field: alt_rate_schedule_no

The number of reset months for each plan

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.

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

Array of custom rates for the services provided in the supplemental plan

See fields below

Purchase order number assigned to the plan instance

Array of coupon details for the plan instance.

See fields below

Coupon code to assign to this plan instance, if any.

Determines whether coupon is for a specific plan instance or also to support mandatory child plans. Note: This is valid only if the auto_assign_mandatory_supp_plans parameter is set to "True". If the user provides a mandatory supplemental plan as input while this flag is "False", they must explicitly include the corresponding plan instance coupon in the request. If no coupon is provided for the specific plan instance, no coupon will be assigned to that instance.

System-defined master subscription plan number. This is the plan number you are assigning to the account. You must assign at least one plan to the account.

Alternative required field: client_plan_id

Client-defined master plan subscription plan ID.

Alternative required field: plan_no

Description for each assigned master plan

Unique client-defined ID for each assigned master plan

For non-persistent referencing of a plan instance within the API request

Code provided by 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

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

Array of plan unit instances

See fields below

Status of the object in question for the current API call

If the value is "1" (Standard Self Pay), the Master Plan Instance must have a billing group, which you assign using either client_billing_group_id or billing_group_idx.

If the value is "2" (Parent Pay) or "3" (Parent Usage & Pay), the Master Plan Instance does not need a billing group, but must have a responsible Master Plan Instance, which you assign using either resp_master_plan_inst_no, client_resp_master_plan_inst_id, or resp_master_plan_inst_idx. The responsible Master Plan Instance must be owned by another account that is a parent or ancestor of the account you are creating.

System-defined identifier for the master plan instance in a parent account that is responsible for payment and/or usage tracking of this master plan. The responsible master plan instance must exist before this API request is executed. Either this field, resp_master_plan_instance_id, or resp_master_plan_instance_idx must be valued if the resp_level_cd is set to either "2" or "3". Otherwise, it must be blank.

Alternative required field: resp_client_master_plan_instance_id, resp_master_plan_instance_idx, client_billing_group_id, or billing_group_idx

Client-defined identifier for the master plan instance in a parent account that is responsible for payment and/or usage tracking of this master plan. The responsible master plan instance must either exist before this API request is executed, or is created within this API request. Either this field, resp_master_plan_instance_id, or resp_master_plan_instance_idx must be valued if the resp_level_cd is set to either "2" or "3". Otherwise, it must be blank.

Alternative required field: resp_master_plan_instance_no, resp_master_plan_instance_idx, client_billing_group_id, or billing_group_idx

Non-persistent identifier for the master plan instance in a parent account that is responsible for payment and/or usage tracking of this master plan instance. The responsible master plan instance must be created within this API request. Either this field, resp_client_master_plan_instance_id, or resp_master_plan_instance_no must be valued if the resp_level_cd is set to either "2" or "3". Otherwise, it must be blank.

Alternative required field: resp_master_plan_instance_no, resp_client_master_plan_instance_id, client_billing_group_id, or billing_group_idx

Client-defined identifier for the billing group to which this master plan instance belongs. Either this field, or billing_group_idx must be valued if the resp_level_cd is set to "1". Otherwise, it must be blank.

Alternative required field: resp_master_plan_inst_no, client_resp_master_plan_inst_id, resp_master_plan_inst_idx, or billing_group_idx

Non-persistent identifier for the billing group to which this master plan instance belongs. Either this field, or client_billing_group_id must be valued if the resp_level_cd is set to "1". Otherwise, it must be blank.

Alternative required field: resp_master_plan_inst_no, client_resp_master_plan_inst_id, resp_master_plan_inst_idx, or client_billing_group_id

Client-defined identifier for the dunning group to which this master plan instance belongs. Each master plan instance must be assigned to one of the dunning groups defined in this API request, using either the client_dunning_group_id or dunning_group_idx.

Alternative required field: dunning_group_idx

Non-persistent identifier for the dunning group to which this master plan instance belongs. Each master plan instance must be assigned to one of the dunning groups defined in this API request, using either the client_dunning_group_id or dunning_group_idx.

Alternative required field: client_dunning_group_id

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. When a master plan is assigned with an alt_start_date and status_until_alt_start as pending activation (32), then the user will not have the option to delete the queued future plan changes for the master plan and supplemental plan. If the user needs to delete the queued future plan change, then select a status other than pending activation.

balance forward

Array of coupon details for the stack

See fields below

Surcharge for master plan.

See fields below

Determines when the NSO order is fulfilled and then billed.

List of services associated with the master plan being assigned on the account

See fields below

Non-Subscription Offerings that are purchased with the plan

See fields below

Purchase order number assigned to the one-time order

See fields below

Aria-assigned identifier for an alternative rate schedule that is assigned to the master plan in place of the default rate schedule

Alternative field: client_alt_rate_schedule_id

Client-defined alternate rate schedule ID

Alternative field: alt_rate_schedule_no

The number of reset months for each plan

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.

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.

Array of custom rates for the services provided in the master plan

See fields below

Purchase order number assigned to the plan instance

Supplemental plan instances assigned directly under a master plan instance

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.

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

Array of coupon details for the plan instance.

See fields below

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.

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.

Defines the child accounts. Zero or more child accounts can be created under the top-level account. Each child account contains the same set of fields as the top-level account, including their own child accounts. This supports the creation of an account hierarchy within a single call to create_acct_complete_m.

Client-defined account identifier.

The user's unique identifier. Every account must have a userid. If the client parameters are not configured to generate this value, the userid must be provided in this API request.

The status of the account after it is created.

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

Password for the given user

User's secret question recorded to recover a password

Response to a user's secret_question

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.

First name of the contact

Middle initial of the contact

Last name of the contact

Company name of the contact

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

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's address

Phone number for the contact

Extension for the contact's phone number

Cell phone number for the contact

Work phone number for the contact

Extension for the contact work phone

Fax phone number for the contact

Email for the contact.

An array containing the list of additional cc email addresses

An array containing the list of additional bcc email addresses

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

Unique account number for the parent account. It is used to establish parent-child billing relationships. This field, or senior_acct_userid, or client_senior_acct_userid, is required if you are using the current API call to create a child account.

Alternative field: senior_acct_userid or client_senior_acct_id

User ID of the parent account

Alternative field: senior_acct_no or client_senior_acct_id

Client-account ID of the parent account

Alternative field: senior_acct_no or senior_acct_userid

Aria-assigned legal entity identification number.

Alternative field: client_legal_entity_id

Client-assigned unique identifier for the legal entity.

Alternative field: legal_entity_no

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

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.

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.

Applicable only for master plan assignment. When provided, this date is used as the bill thru date for the master plan instance. The alt_start_date or retroactive_start_date input is honored with override_bill_thru_date, but invoicing_option must be set to Perform Prorated Invoicing. 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 is 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) is the override_bill_thru_date + 1 day. If the plan has usage services, then the next_bill_date is calculated based on the usage interval to be the earliest date in the future that ensures usage and recurring services are invoiced together on the override_bill_thru_date + 1 day.

Array of functional account groups

See fields below

Array for collection account groups.

See fields below

Assigns one or more supplemental field values to the account

See fields below

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

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

3-character ISO-compliant currency code in lowercase for monetary values used for this account

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

Taxpayer identification number

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

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

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

Creates an Aria session for the newly created account. Within an Aria session, you can perform functions such as securely processing payment transactions or securely retrieving account information in registration or User Self Service applications.

See fields below

Array of coupon details for the account

See fields below

See fields below

This array contains information about the account's billing groups. A billing group defines the statement configuration, primary payment method, and/or backup payment method for one or more master plan instances.

See fields below

This array contains information about the account's dunning groups. A dunning group defines the process followed for delinquent payments associated with one or more master plan instances. Each account must have at least one master plan instance, and each master plan instance must have a dunning group. Therefore, you must define at least one dunning group for each account in the API request.

See fields below

See fields below

Allows multiple master plans subscription for an account

See fields below

Indicates that the account represents a single individual, used primarily in Business-to-Consumer (B2C) business models. The primary purpose of this field is to support Person Accounts objects in Salesforce via Aria for Salesforce.

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 takes precedence over revrec_profile_no.

Alternative field: revrec_profile_no

Purchase order number assigned to the account.

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

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.

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.

Governs the behavior of mandatory supplemental plans. If set to yes, it will include all the mandatory supp plans belonging to the parent plan without having to explicitly set them. If set to no, you must enter each of those mandatory supp plans. Allowable Values - true/false. This will override the "Included by Default" setting in the Product Catalog for a given supplemental plan.

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

Alternative field: client_notification_template_group_id

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

Alternative field: notification_template_group_no

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

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

Aria-assigned error identifier. 0 indicates no error.

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

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

The processor returned response fields at the time of payment method creation failure

See fields below

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.

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.

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

Value provided for the idx parameter in the API request

List of plan instance(s) to be associated with the contract

List of client-defined plan instance(s) to associated with the contract

Unique ID of the contract assigned to this account

Client-assigned unique contract identifier

See fields below

Specifies the scope of plan subscription coverage enforced by the contract

Aria-defined error code specific to any error encountered during any invoicing/billing processes performed inline as a result of this method call

The explanatory text corresponding to the value returned (if any) in output "invoicing_error_code"

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

Text message associated with statement_error_code

The billing group number mapped against each master plan

Client-defined billing group ID

Aria unique plan unit instance number

Client-assigned identifier for the plan unit instance

Aria unique plan-unit instance number

Client-assigned identifier for the plan unit instance

Unique plan-instance number for each assigned supplementary plan

Unique client-defined ID for each assigned supplementary plan

Array of plan unit instances

See fields below

Unique ID of the contract assigned to this account

Unique plan-instance number for each assigned master plan

Unique client-defined ID for each assigned master plan

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

Unique plan-instance number for each assigned master plan

Unique client-defined ID for each assigned master plan

Unique identifier for an order that is created for bundled NSOs

Status label for this order

Array of plan unit instances

See fields below

See fields below

See fields below

Errors from third-party systems like taxation engines are returned here, whereas the 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

The line number on the initial invoice

The unique ID plan this line represents

The client-defined unique ID for plan this line represents

Unique plan instance number for each assigned master plan.

Unique client-defined ID for each assigned master plan.

The name of the plan this line represents

The unique ID for the service this line represents

The client-defined unique ID for the service this line represents

The name of the service this line represents

The Chart of Accounts ID for the service this line represents

The client-defined Chart of Accounts code for the service this line represents

The number of units of the item or plan on this line

The charge per unit of the item or plan on this line

The subtotal amount of this line

The long description of this line, used when printing or otherwise displaying invoices

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.

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

Specifies the full, non-prorated number of units of the service code.

Specifies the percentage of the line_base_units billed.

Specifies the prorated days in total days.

Prorated days of period in this invoice

Prorated invoice description.

Specifies the coupon code applied to the invoice.

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

The unique ID of the item being retrieved.

Total days of period in this invoice.

Aria-assigned unique identifier for the rate schedule used to generate this invoice line item. Either the catalog rate of this rate schedule is used for this line item or the account custom rate against this underlying rate schedule is used.

Sequential number in the rate schedule for determining tiers.

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 returns 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 returns the Aria-assigned unique identifier of the contact on the account used as the ship-to address for the invoice 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

Line number associated with each tax detail record

Tax line on the invoice which includes the tax amount associated with this tax_detail_line

Invoice line item for which the tax for this tax_detail_line was calculated.

Amount of tax applied for the given tax type

Tax jurisdiction code: 0 = Federal, 1 = State / Province.

Rate at which tax is calculated for the tax type used by the tax engine

Indicates whether the invoice line amount was tax inclusive

Identifier of the tax type returned by the tax engine

Description of the tax type returned by the tax engine

Category of the tax type returned by the tax engine

Jurisdiction name returned by the tax engine

Invoice summary text returned by the tax engine

The amount multiplied by tax rate before rounding precision. Also referred to as raw tax amount. *Note: Aria internal tax rounding method set to invoice.

The amount that is a carryover from previous unrounded tax amt. It is remainder and value can be positive or negative based on the previous remainder. *Note: Aria internal tax rounding method set to invoice.

The amount adjusted Tax before rounding precision. i.e. Sum of unrounded_tax_amt, and carryover_from_prev_amt. *Note: Aria internal tax rounding method set to invoice.

The amount that is a carryover from current unrounded tax amt. It is remainder and value can be positive or negative based on the previous remainder. *Note: Aria internal tax rounding method set to invoice.

Nominal Rate returned by the tax engine.

Fraud country status provided by the Payment processor.

Fraud country code provided by the Payment processor.

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.

The Aria-assigned unique identifier of a given invoice.

The billing group number mapped against each master plan.

Client-defined billing group ID.

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.

Charges before tax on the initial invoice for this account

Tax charges on the initial invoice for this account

The sum of invoice_charges_before_tax and invoice_tax_charges

The amount of credit on the initial invoice for this account

The total owed on the initial invoice for this account

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

The tax amount of the credit to be applied.

The credit to be applied before tax is taken into account.

The grand total of this invoice.

The currency amount of any resulting proration action performed as a result of the fulfillment based service unit assignment. When proration is performed the value returned in this field will be a positive currency value (indicating a resulting charge to the account). If the value passed in field do_write is false then any positive value returned in this field is notational only, demonstrating what proration effect would be applied to the account if the requested fulfillment based plan unit instance were to be actually assigned.

The predicted monthly recurring cost of the items and plans on this invoice.

The predicted annual recurring cost of the items and plans on this invoice.

See fields below

See fields below

Fraud Filtering Response returned from Payment processor.

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

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 account identifier. This value is unique across all Aria-managed accounts.

The user ID, unique among all accounts for this Aria client, assigned to the newly created account. If input parameter "user_id" was provided, the same value is returned. If no "user_id" was provided as input and the client is configured within Aria for automatic generation of random user_id values OR is configured to use account email addresses as user_ids, the generated value is returned.

Client-defined account identifier.

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

Name of the account level locale.

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

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

See fields below

Returns the newly created cookie ID of the account

See fields below

See fields below

See fields below

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

See fields below

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.

For non-persistent referencing of a payment method within the API request to be used as the primary or backup payment method on the billing group.

Client-defined unique identifier for the payment method.

The processor status code

The processors status description