Home > Aria Crescendo Documentation > Aria Crescendo core api > update_acct_plan_m

update_acct_plan_m

This API updates in the context of an account's plan instance that plan's rates, number of units, associated coupons, status, plan instance description, plan instance fields, usage management tracking, and/or service location.

For information on error messages generated by this API, see update_acct_plan_m Error Messages.

Input Arguments

Req Field Name Field Type Max Length Description
required-icon.png client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
required-icon.png auth_key string 32 Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.
required-icon.png acct_no long 22 Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
  OR      
  client_acct_id string 50 Client-defined account identifier.
required-icon.png plan_instance_no long 22 The unique identifier of the account's plan instance that this API call will update.
  OR      
  client_plan_instance_id string 100 The client-defined identifier of the account's plan instance that this API call will update.
  alt_rate_schedule_no long 8 Alternative Rate Schedule Number. The alt_rate_schedule_no is the unique identifier for an alternative rate schedule that can be assigned to the account holder in place of the default rate schedule. This is often done by CSR's to provide special compensation or discounts as incentives to account holders.
  OR      
  client_alt_rate_schedule_id string 100 Client-defined alternate rate schedule identifier to assign (if any). If none is specified, the default rate schedule number will be used.
  plan_units double   The units of the plan added at this change
  coupon_codes string array 30 The coupon codes to assign to this master plan instance, if any
  promo_cd string 30 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. For promo code removal, use the alpha erase indicator value '~' (tilde).
  plan_status long 4 Updates the plan status for the plan instance.  
Values Description
1 Active
31 Pending Installation
32 Pending Activation
61 Active Non-Billable
41 Trial
-1 Suspended
  plan_instance_description string 1000 Updated the description for the plan instance.
  billing_group_no long 22 The billing group number mapped against each master plan.
  client_billing_group_id string 38 The client-defined billing group ID mapped against each master plan.
Start of plan_instance_field_update array
  plan_instance_field_update array    
  Field Name Field Type Max Length Description
  brd_arrow.gif plan_instance_field_name string 100 Required if you wish to update a plan instance field value associated with the specified plan instance.
  brd_arrow.gif plan_instance_field_value string 100 Required based on the definition of each plan instance field associated with the new plan.
  brd_arrow.gif plan_instance_field_directive long 8 Required for each plan instance field provided.  
Values Description
1 Add name and value for a new plan instance field.'
2 Replace value of an existing plan instance field.
3 Remove the value of an existing plan instance field, note that if the plan instance field is required based on the field definition, the Replace directive should be used.
4 Remove the name and value of an existing plan instance field from the plan instance.
End of plan_instance_field_update array
 
  assignment_directive long 8 The rule to be applied to this assignment request, governing the proration rule is applied. Default behavior is to make the plan change (assign/deassign a plan to an account, change units on an existing plan, etc.) immediately based on client-defined default proration rule, resulting in appropriate prorated charge and credit. Usage-arrears charges, recurring-in-arrears charges, and any plan cancellation fees (if applicable) will be invoiced during plan cancellation, as these charges are independent of assignment directive. 
Values Description
1 (Default) Perform the requested plan change on the account's next scheduled billing anniversary date. The account does receive service under this plan (for plan assignments) or have it removed (for de-assignments) until that date. If a plan is being assigned, initial billing for a full period of the given plan is performed on the account's next scheduled anniversary date. No charge or credit proration effect. No new recurring charges or credits are generated when no proration occurs.
2 Perform the requested plan change immediately, honoring the client's pre-configured universal rule for performing or not performing proration as a result of a mid-billing-period plan assignment or de-assignment. No new recurring charges or credits are generated when no proration occurs. (default)
3 Perform the requested plan change immediately, ignoring the client's pre-configured universal rule for performing or not performing proration and forcing NO PRORATION. No new recurring charges or credits are generated when no proration occurs.
4 Perform the requested plan change immediately, ignoring the client's pre-configured universal rule for performing or not performing proration and forcing PRORATION.
5 Perform the requested plan change immediately, ignoring the client's pre-configured universal rule for performing or not performing proration and forcing PRORATION FOR CHARGES ONLY. NOTE: This value is not permitted when cancelling supplemental plans.
6 Perform the requested plan change immediately, ignoring the client's pre-configured universal rule for performing or not performing proration and forcing PRORATION FOR CREDITS ONLY. NOTE: This value is not permitted when assigning supplemental plans.
7 Perform the requested plan change on the specified effective_date, honoring the client's pre-configured universal rule for performing or not performing proration as a result of a mid-billing-period plan assignment or de-assignment. No new recurring charges or credits are generated when no proration occurs.
8 Perform the requested plan change on the specified effective_date, ignoring the client's pre-configured universal rule for performing or not performing proration and forcing NO PRORATION. No new recurring charges or credits are generated when no proration occurs.
9 Perform the requested plan change on the specified effective_date, ignoring the client's pre-configured universal rule for performing or not performing proration and forcing PRORATION.
10 Perform the requested plan change on the specified effective_date, ignoring the client's pre-configured universal rule for performing or not performing proration and forcing PRORATION FOR CHARGES ONLY. NOTE: This value is not permitted when cancelling a supplemental plan.
11 Perform the requested plan change on the specified effective_date, ignoring the client's pre-configured universal rule for performing or not performing proration and forcing PRORATION FOR CREDITS ONLY. NOTE: This value is not permitted when assigning a supplemental plan.
  comments string 500 Additional explanatory text relating to this API call.
  do_write string 5 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'  
Values Description
true true
false false
  client_receipt_id string 50 Client-defined unique identifier used to track related system actions
Start of custom_rates array
  custom_rates array   An array of custom rates for the specified account number
  Field Name Field Type Max Length Description
  brd_arrow.gif custom_rate_service_no long 22 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.
  OR      
  brd_arrow.gif custom_rate_client_service_id string 100 The unique identifier by client the service ID to determine which custom rate is to be applied for this account.
  brd_arrow.gif custom_rate_seq_no long 22 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.
  brd_arrow.gif custom_rate_from_unit long 22 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.
  brd_arrow.gif custom_rate_to_unit long 22 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.
  brd_arrow.gif custom_rate_per_unit double 22 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.
End of custom_rates array
 
  effective_date string 10 If the assignment directive is for a future date assignment, this is the date, in yyyy-mm-dd format, on which the plan change will be executed. If this field is NULL, then the plan change will not happen until it is manually executed or until the effective_date is updated.
  offset_interval long 4 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.
  force_master_bill_date_reset long 1 Overrides the "Sync_mstr_bill_dates_on_1st_supp" client-level setting that determines whether or not no-charge master plan billing dates should be reset when assigning a new supplemental plan or when the supplemental plan instance status is updated to a billable status. If this value is left empty, the client-level setting will take effect.  
Values Description
  If this value is left empty, the client-level setting (Sync_mstr_bill_dates_on_1st_supp) will take effect.
1 Do not reset master plan billing dates.
2 Reset master plan billing dates if master plan is "free", the account has no "billable" supplemental plans, and the newly-assigned supplemental plan is "billable.
3 Reset master plan billing dates if master plan is "free" and the account has no active supplemental plans.
  new_client_plan_inst_id string 100 identifier for a parent account master plan. Required if resp_level_cd is 2 or 3.
  dunning_state long 1

Dunning state assigned to the master plan instance. In Progress indicates the master plan is in dunning. None indicates the master plan is not in dunning. Note that dunning state is applicable only for master plans and is set to Complete by the system once the dunning process is completed.  

If you set this field to 1 (in progress), then you can specify one or more of the following dunning options available in these fields:

  • <degrade_date>;
  • <new_dunning_step>;
  • <config_dunning_late_fee_option>; and/or
  • <config_dunning_email_option>.

Note 1:

  • When you change the <dunning_state> to 0 (none), you should also pass in your chosen  <plan_status> for the MPI (master plan instance).

    Example: you may want to change the MPI's status from
    -1 (suspended) to 1 (active).
  • If you set this field to 1 (in progress) but the MPI does not have a balance due, then Aria will move the MPI out of dunning on the date on which the next dunning step begins.This applies to MPIs associated with either payment type: net terms or electronic.

 

Note 2:

In addition to self-pay MPIs, dunning input arguments can now also now be used for parent-pay MPIs. Also note that when self-pay MPI manually enters dunning via this API, all of their parent-pay MPIs will enter dunning. This is only applicable when entering the dunning. During this special process of entering parent-pay MPI, the “config_dunning_late_fee_option and config_dunning_email_option” will only be applicable for self-pay MPIs and NOT to the parent-pay MPI.

Values Description
0 None
1 In Progress
  degrade_date string 10

Date on which the Dunning Manager evaluates whether the master plan should be advanced to the next step of the dunning process.

Applicable only for master plans, and only if the <dunning_state> is set to 1.

For more information about available dunning options, please see the <dunning state> field.
  resp_level_cd long 1 The responsibility level code. These are values 1 through 4 as described in the legend for this argument.  
Values Description
1 Standard Self-Pay: default
2 Parent Pay: Usage accrues under self, invoices are generated per self's plan rules BUT are presented for payment against parent account'
3 Parent Usage & Pay: Usage accrues under parent and applied only to parent's plan rules and presented to parent for payment'
  parent_acct_master_plan_inst_id (DEPRECATED) string 100 Unique identifier of a plan in the plan instance hierarchy under which the new plan will be assigned.
  usage_accumulation_reset_months long 4 The number of reset months for each plan.
  usage_pooling string 5 Indicates whether usage pooling is enabled for this plan instance. Allowable values are 'true' and 'false'.  
Values Description
true Usage pooling is enabled for this plan instance.
false (default) Usage pooling is not enabled for this plan instance.
  usage_threshold_applicability string 2 Usage tracking options on the plans in the account  
Values Description
UT Usage Type
UP Usage Pool
Start of mp_surcharges array
  mp_surcharges array   Surcharge for master plan
  Field Name Field Type Max Length Description
  brd_arrow.gif mp_surcharge_no long 22  
  brd_arrow.gif mp_surcharge_directive long 1 The surcharge directive to assign/remove the surcharge from the master plan instance  
Values Description
1 Apply surcharge to account
2 Remove surcharge from account
  brd_arrow.gif mp_rate_schedule_no long 22  
End of mp_surcharges array
 
  proration_invoice_timing long 1 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.  
Values Description
Null(default) Honor Proration Invoice Timing configuration saved with the plan in the product catalog.
0 Indicates to generate the invoice immediately for the pro-rated charges.
1 Indicates to generate the invoice to the next anniversary date for the pro-rated charges.
  po_num string 100 Purchase order number assigned to the plan instance.
Start of plan_update_services array
  plan_update_services array   List of services associated with the plan being assigned or updated on the account.
  Field Name Field Type Max Length Description
  brd_arrow.gif service_no long 22 The Aria-assigned unique identifier for the service associated with the plan instance. Either this field or client_service_id is required to map plan services to the plan instance.
  OR      
  brd_arrow.gif client_service_id string 100 The client-defined identifier for the service associated with the plan instance.
  brd_arrow.gif svc_location_no long 22 The Aria-assigned unique identifier for the origin location for the specified service associated with the plan. Depending on taxation configuration, this address may be used for tax calculations. If both svc_location_no and client_svc_location_id are provided, svc_location_no will take precedence.
  brd_arrow.gif client_svc_location_id string 100 The client-defined unique identifier for the origin location for the service associated with the plan. Depending on taxation configuration, this address may be used for tax calculations. If both svc_location_no and client_svc_location_id are provided, svc_location_no will take precedence.
  brd_arrow.gif dest_contact_no long 22 The Aria-assigned unique identifier for the destination contact for the specified service associated with the plan. Depending on taxation configuration, this address may be used for tax calculations.
End of plan_update_services array
 
  plan_instance_supp_field_update_only long 1 This field controls the ability to update plan instance fields on a plan that is in non-provisioned status.  
Values Description
  This input will not allow plan instance fields to be update for plans that are in a non-provisioned status
0 This input will not allow plan instance fields to be update for plans that are in a non-provisioned status
1 This input will allow plan instance fields to be update for plans that are in a non-provisioned status
  force_bill_date_reset long 1 When a master plan's status changes from non-billable to billable, this input will determine what the billing dates of the specific master plan and all associated supplemental plans anniversary date will be.  
Values Description
  Reset the billing dates when the status changes from non-billable to billable depending on client parameter 'AUTO_RESET_MASTER_PLAN_BILLING_DATES_ON_NON_BILLABLE_TO_BILLABLE_MASTER_PLAN_STATUS_CHANGE' setting.
0 Do not reset the billing dates for this plan.
1 Reset the billing anniversary date to coincide with the status change date.
2 Reset the billing anniversary date to coincide with the current anniversary date.
  force_currency_change string 5 Force currency change during update. Necessary to accommodate for an account holder moving from one area to another where the local currency is different.
Values Description
true When the plan being updated has a rate schedule with a different currency or the supplied alternate rate schedule has rates defined in different currency, a 'true' value will allow the currency change provided that there are no transactions (or only $0 transaction present) for that account and the new plan/alt rate schedule has the rates defined in the target currency.
false When the plan being updated has a rate schedule with a different currency the supplied alternate rate schedule has rates defined in different currency, a 'false' value will not allow the currency change.
  alt_caller_id string 30 Person or process that submitted the API call. This can be someone's user ID, or the name of an application.
Start of optional_transaction_qualifiers array
  optional_transaction_qualifiers array   Array of additional values you can associate with this API call.
  Field Name Field Type Max Length Description
  brd_arrow.gif qualifier_name string 100 Name of the field you want to associate with this API call.
  brd_arrow.gif qualifier_value string 100 Corresponding value of the field you want to associate with this API call.
End of optional_transaction_qualifiers array
 
  application_id string 300 The application identifier in which the API is being used in. (Example: “Sales Force”)
  application_date string 300 The application date/timestamp, ie. 01/01/2014 10:00:00 to track when the application called the API.
  remove_pi_custom_rates string 5

Determines whether to keep or remove any custom rates assigned to a plan instance when you change the rate schedule of that plan instance.

Values Description
true Remove the custom rates and use the default rates of the new rate schedule that you assigned.
false (default) Keep the custom rates currently assigned to the plan instance.
  new_dunning_step long 2

Pass in the step in the dunning process that the MPI should move to. 

Applicable only for master plans, and only if the <dunning_state> is set to 1.

For more information about available dunning options, please see the <dunning state> field.
  config_dunning_late_fee_option long 1

If the dunning step that you passed into the <new_dunning_step> field includes a late fee, specify whether to charge or suppress it.

Applicable only for master plans, and only if the <dunning_state> is set to 1.

For more information about available dunning options, please see the <dunning state> field.

Note: If you set this field to 1, Aria will immediately charge the customer the late fee.

Values Description
1 Use dunning process configuration settings (default).
0 Do not use dunning process configuration/do not charge late fee.
 
config_dunning_email_option		 long 1

If the dunning step that you passed into the <new_dunning_step> field includes an email notification, specify whether to send or suppress it.

Applicable only for master plans, and only if the <dunning_state> is set to 1.

For more information about available dunning options, please see the <dunning state> field.

Note: If you set this field to 1, Aria will immediately email the notification to the customer.

Values Description
1 Use dunning process configuration settings (default).
0 Do not use dunning process configuration/do not send email notification.
  application_id string 300 The application identifier in which the API is being used in. (Example: “Sales Force”)
  recurring_processing_model_ind long 1 Defines a recurring payment type for Credit Card and Tokenized Credit Cards. 
Values Description
0 Cardholder-Initiated Transaction – Credentials on File: a credit card transaction initiated by the cardholder for a new order or a plan upgrade that uses a credit card that is currently stored in Aria. (Default)
1 Cardholder-Initiated Transaction: a credit card transaction initiated by the cardholder for a new account or creating an order that uses an alternate credit card that is not currently stored in Aria.
2 Merchant-Initiated Transaction – Standing Instruction – Recurring: a credit card transaction initiated by Aria’s clients for a recurring charge that uses a credit card that is currently stored in Aria.
3 Merchant-Initiated Transaction – Unscheduled Credentials on File: a credit card transaction initiated by Aria’s clients for a non-recurring charge (one-time order or plan upgrade) that uses a credit card that is currently stored in Aria.
  usage_accumulation_reset_months_renewal_option long 1 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.  
Values Description
NULL or 1 Recurring / Auto Renew.(Default)
2 Single Use.
  include_plan_instance_queue string 5 Use this field to obtain the list of plan changes that you scheduled using this API.
Values Description
false Scheduled plan changes will not be returned in the plan_instance_queue array (default).
true Scheduled plan changes will be returned in the plan_instance_queue array.
  bill_lag_days long 10

Bill lag days are the number of days prior to (negative) or after (positive) an account billing date at which an invoice should be generated for your specified master plan instance. 

Negative bill lag days are typically used for subscription-based services (often subscription-based services paid using net terms), for which you would like to send out invoices to your customers well in advance of the real invoice date. This gives your customers time to receive a paper or email invoice (statement) and send a payment before the actual invoice date.

Positive bill lag days typically apply to usage-based services. 

Examples:

  • If you want an invoice to be generated 14 days before the billing date, pass -14 into this field.
  • If you want an invoice to be generated 10 days after the billing date, pass 10 into this field.

By default, bill lag days are restricted to +/- the (minimum number of days in a recurring billing period – 1 day). However, if your  Allow Negative Bill Lag Days to Extend Beyond One Bill Cycle parameter is set to True (in the Aria application under Configuration > Billing> Invoice Settings), then the negative value can go beyond a single billing period.

Bill lag days can be removed via APIs update_acct_plan_m, replace_acct_plan_m, update_acct_plan_multi_m and update_acct_complete_m). To remove the MPI bill lag days, pass the standard "numeric erase" indicator of a tilde (~) for <bill_lag_days> input.

Note:

  • Although ‘-999’ happens to be a valid bill_lag_days value when the your parameter “_Allow Negative Bill Lag Days to Extend Beyond One Bill Cycle_” is “True”, it is obviously not practical as a real value on the APIs as there are not many plausible scenarios where a customer would be invoiced that far in advance.

Aria will set the bill lag days for plans using this order of precedence:

  1. Master plan instance (for a given account)
  2. Collection group setting
  3. Payment terms/payment method setting
  4. Client setting (Configuration > Billing > Bill Lag Days)

Notes:

  • You cannot pass a value into the <bill_lag_days> field by itself. You must also pass in a value to update the plan units, plan status, and/or alternate rate schedule.
  • <bill_lag_days> cannot be passed in as part of an API call used to schedule changes that will take place on a customer's anniversary date. You must set the <bill_lag_days> to go into effect on a date other than the anniversary date.

    Example: If you have an MPI replacement scheduled for a customer's anniversary date, you should not set <bill_lag_days> in the API used for the MPI replacement. If you do, Aria will ignore the <bill_lag_days>.
Start of proc_field_override array
  brd_arrow.gif proc_field_override array  

Your chosen data to send to your payment gateway passed as an array of proc_field_name/proc_field_value key-value pairs.

The allowable field(s) and values for the key-value pairs are listed below.
  Field Name Field Type Max Length Description
    brd_arrow.gifbrd_arrow.gif transaction_type string 2

If you use Chase Paymentech or Vantiv, this field allows you to tell that payment gateway which transaction type is involved (examples: single or recurring transaction) when you process a customer's  payment information.

This field applies to credit cards and tokenized credit cards. If you don't pass a value into this field, it will default to -1 (use client configuration settings).

 

Notes:

  • The value that you pass into this field will override the Recurring Options that you set in the Aria application under:
    • Configuration > Payments > Payment Gateways > Chase Paymentech/Vantiv > Gateway Options; and
    • Configuration > Payments > Collection Groups > Chase Paymentech/Vantiv > Collection Group Options.
  • Currently, only Chase Paymentech and Vantiv support this field. Other payment gateways might not honor all of the allowable values for this field. You will need to check your payment gateway documentation for confirmation.
 

Aria will use this order of precedence to determine the transaction type:

  1. value passed into this field
  2. collection group configuration
  3. payment gateway configuration
  4. transaction type that you specified in the <recurring_processing_model_ind> field
Values Description
-1 Use client configuration settings for "Send Transaction Type as Recurring for Initial Request Where Possible" or "Send Transaction Type as Recurring for Subsequent Request" as applicable. (default)
1 (Chase) Single transaction mail/telephone order (MOTO) - Designates a transaction where the accountholder is not present at a merchant location and completes the sale over the phone or through the mail. The transaction is not for recurring services or products and does not include sales that are processed via an installment plan.
2 (Chase) Recurring Transaction - Designates a transaction that represents an arrangement between an accountholder and the merchant where transactions are going to occur on a periodic basis.
3 (Chase) Installment Transaction - Designates a group of transactions that originated from a single purchase where the merchant agrees to bill the accountholder in installments.
4 (Chase) Deferred Transaction - Designates a transaction that represents an order with a payment delayed for a specified amount of time.
5 (Chase) Secure Electronic Commerce Transaction - Designates a transaction completed via the Internet at a 3-D Secure capable merchant and in which the accountholder was fully authenticated. (examples: 3-D Secure includes Verified by Visa, Mastercard Identity Check, American Express SafeKey and Discover ProtectBuy.)
6 (Chase) Non-Authenticated Electronic Commerce Transaction - Designates a transaction completed via the Internet at a 3-D Secure capable merchant that attempted to authenticate the accountholder using 3-D Secure (examples: 3-D Secure includes Verified by Visa and Mastercard Identity Check.) Verified by Visa, Mastercard Identity Check, American Express SafeKey and Discover ProtectBuy transactions in the event of: * A non-participating issuer * A non-participating accountholder of a participating issuer * A participating issuer, but the authentication server is not available
7 (Chase) Channel Encrypted Transaction - Designates a transaction between an accountholder and a merchant completed via the Internet where the transaction includes the use of transaction encryption such as SSL (Secure Sockets Layer), but authentication was not performed. The accountholder payment data was protected with a form of Internet security, such as SSL, but authentication was not performed. For Discover, indicates an e-commerce Card Transaction with data protection in which ProtectBuy for Cardholder authentication was not used.
8 (Chase) Non-Secure Electronic Commerce Transaction - Designates a transaction between an accountholder and a merchant completed via the Internet where: * The transaction does not include the use of any transaction encryption such as SSL * Authentication is not performed * An accountholder certificate is not managed.
I (Chase) IVR Transaction (PINless Debit only) - Designates a transaction where the accountholder completes the sale via an interactive voice response (IVR) system.
R (Chase) Retail Transaction - Designates a transaction where the accountholder was present at a merchant location.
telephone (Vantiv) The transaction is for a single telephone order.
mailorder (Vantiv) The transaction is for a single mail order transaction.
 

resp_master_plan_instance_no

 

 

 

OR

 

resp_client_master_plan_instance_id

long

 

 

 

 

 

string

22

 

 

 

 

 

100

The Aria-assigned identifier of the master plan instance that will have payment responsibility for the assigned plan.    

Required if the responsibility level (in the <resp_level_cd> field) is set to one of the two parent pay options.
 

 

The client-defined identifier of the master plan instance that will have payment responsibility for the assigned plan.    


Required if the responsibility level (in the <resp_level_cd> field) is set to one of the two parent pay options.

Output Arguments

Field Name Field Type Description
error_code long Aria-assigned error identifier. 0 indicates no error.
error_msg string Textual description of any error that occurred. "OK" if there was no error.
proration_result_amount double The currency amount of any resulting proration action performed as a result of the requested plan change. For plan assignments with an assignment directive of '1' (perform on anniversary date), or '2' (honor client default proration action) when the default configuration is to not do proration, or '3' (force no proration), the value returned in this field will always be '0'. When proration is performed the value returned in this field will either be a positive currency value (indicating a resulting charge to the account) or a negative currency value (indicating a credit to the account). If the value passed in field do_write is false then any positive or negative value returned in this field is notational only, demonstrating what proration effect would be applied to the account if the requested plan assignment/de-assignment were to be actually performed.
collection_error_code long If a collection is attempted, returns the error code associated with the collection.
collection_error_msg string The error message associated with collection_error_code.
statement_error_code long The error code if statement generation fails.
statement_error_msg string The text message associated with 'statement_error_code'
proc_cvv_response string The processor return code from CVV validation.
proc_avs_response string Processor return code from address validation
proc_cavv_response string The processors return code for security validation.
proc_status_code string The processor status code
proc_status_text string The processors status description
proc_payment_id string The processor payment ID
proc_auth_code string Authorization code provided by the issuing bank
proc_merch_comments string Additional information passed to payment processor
invoice_no long The Aria-assigned unique identifier of a given invoice.
expectd_activation_fee double The activation fee the account holder can expect based on the activation fees of the plans on this invoice
expectd_mthly_recurring_cost double Regardless of the billing interval on the account, the monthly recurring cost of this change
expectd_annu_recurring_cost double  
acct_plan_line_items hash  
brd_arrow.gif line_no long The line number on the initial invoice
brd_arrow.gif line_type long Specifies the type of charge or credit associated with this line item.  
Values Description
1 Recurring charge
2 Tax charge
3 Service credit
4 Coupon Credit
5 Activation Charge
6 Usage Charge
7 Recurring arrears charge
8 Order charge
9 Surcharge
brd_arrow.gif service_no long The unique ID for the service this line represents
brd_arrow.gif service_name string The name of the service this line represents
brd_arrow.gif line_units double The number of units of the item or plan on this line
brd_arrow.gif rate_per_unit double The charge per unit of the item or plan on this line
brd_arrow.gif line_amount double Specifies the total charge associated with this line item.
brd_arrow.gif line_base_units double Specifies the full, non-prorated number of units of the service code.
brd_arrow.gif proration_factor double Specifies the percentage of the line_base_units billed.
brd_arrow.gif description string The long description of this line, used when printing or otherwise displaying invoices
brd_arrow.gif date_range_start string The starting date range for the item or plan on this line
brd_arrow.gif date_range_end string If any, the ending date range for the item or plan on this line.
brd_arrow.gif credit_coupon_code string Specifies the coupon code applied to the invoice.
brd_arrow.gif plan_no long The unique ID plan this line represents
brd_arrow.gif plan_name string The name of the plan this line represents
brd_arrow.gif client_service_id string Client-defined unique service identifier.
brd_arrow.gif client_plan_id string Client-defined unique Plan Identifier
brd_arrow.gif po_num string Purchase order number assigned to the account or plan instance.
brd_arrow.gif bill_from_address_no long 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.
brd_arrow.gif ship_from_address_no long 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.
brd_arrow.gif bill_to_address_no long Address sent as the bill-to address to the tax engine for tax calculations. This parameter will return the Aria-assigned unique identifier of the contact on the account used as the bill-to address for the invoice line item.
brd_arrow.gif ship_to_address_no long Address sent as the ship-to address to the tax engine for tax calculations. This parameter will return the Aria-assigned unique identifier of the contact on the account used as the ship-to address for the invoice line item.
total_charges_before_tax double Total amount to be charged to the account before taxes have been calculated.
total_tax_charges double Total taxes as calculated for the amount of the transaction.
total_charges_after_tax double Total amount to be charged to the account after taxes have been calculated.
total_credit double The total amount of the credit to be applied to the account
total_tax_credit double The tax amount of the credit to be applies
total_credit_before_tax double The credit to be applied before tax is taken into account
total double The grand total of this invoice
proration_tax_amount double The pro-rated tax credit amount
proration_credit_result_amount double The total pro-rated credit amount
proration_credit_amount double The non-tax pro-rated credit amount
proc_initial_auth_txn_id string 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.
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.
Powered by CXone Expert ®