Home > Aria Crescendo Documentation > Aria Crescendo core api > modify_acct_plan_unit_instances_m

modify_acct_plan_unit_instances_m

Use this API to assign a new Plan Unit  Instance to a specified plan, or to remove a Plan Unit Instance from a specified plan. The <do_write> input variable option on this API allows for the previewing of charges for the desired units modification.

For error messages generated by this API, see modify_acct_plan_unit_instances_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      
required-icon.png client_acct_id string 50 Client-defined account identifier.
required-icon.png plan_inst_no long 22 The unique identifier of the new plan replacing the existing plan on the instance.
  OR      
required-icon.png client_plan_inst_id string 100 The client-defined identifier of the new plan replacing the existing plan on the instance.
Start of remove_plan_units array
  remove_plan_units array   Array of plan units associated with the account. This remove action has precedence over adding units. Thus, if this array is present, then <new_plan_units> to add will be ignored.
  Field Name Field Type Max Length Description
  brd_arrow.gif plan_unit_inst_no long 22 The unique identifier of the plan unit instance to be removed. This API expects all plan unit instances to be for the same <plan_inst_no> or <client_plan_inst_id>
  OR      
  brd_arrow.gif client_plan_unit_inst_id string 100 The client-defined identifier of the plan unit instance to be removed. This API expects all plan unit instances to be for the same <plan_inst_no>, or <client_plan_inst_id>.
End of remove_plan_units array
 
  assignment_directive long 2

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.  

Allowable values for assignment_directive: 

Values Description
1 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 (Default) 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.
  new_plan_units double 12 Number of additional units of the specified plan to be assigned to the account
  new_client_plan_unit_inst_id string array 100 Client-defined ID to be used for a given plan unit being assigned to the account.
  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.  

Allowable values for proration_invoice_timing: 

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

Allowable values for do_write: 

Values Description
true true
false false
  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
 

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
cancelled_supp_plans hash An array containing the supplemental plans cancelled. (DEPRECATED)
brd_arrow.gif supp_plan_no long The unique ID of the supplemental plan
brd_arrow.gif supp_plan_name string The name of the supplemental plan
brd_arrow.gif supp_proration_result_amount double The result of the proration calculation for the unused portion of the billing period
brd_arrow.gif client_supp_plan_id string Client-defined supplemental plan ID.
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  
invoice_line_items    
brd_arrow.gif line_type long

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

Allowable values for line_type: 

Values Description
1 Recurring charge
2 Tax charge
3 Service credit
4 Coupon Credit
5 Activation Charge
6 Usage Charge
7 Recurring Arrears
8 Order Charge
9 Surcharge
brd_arrow.gif units double Specifies the number of units of this service code billed on this line item. On a prorated invoice, line_units = line_base_units X proration_factor.
brd_arrow.gif amount double Specifies the total charge associated with this line item.
brd_arrow.gif base_plan_units double Specifies the full, non-prorated number of units of the service code.
invoice_line_item hash DEPRECATED
brd_arrow.gif line_no long The line number on the initial invoice DEPRECATED
brd_arrow.gif line_type long

Specifies the type of charge or credit associated with this line item.DEPRECATED
brd_arrow.gif service_no long The unique ID for the service this line represents DEPRECATED
brd_arrow.gif service_name string The name of the service this line represents DEPRECATED
brd_arrow.gif line_units double The number of units of the item or plan on this line DEPRECATED
brd_arrow.gif rate_per_unit double The charge per unit of the item or plan on this line DEPRECATED
brd_arrow.gif line_amount double Specifies the total charge associated with this line item. DEPRECATED
brd_arrow.gif line_base_units double Specifies the full, non-prorated number of units of the service code. DEPRECATED
brd_arrow.gif proration_factor double Specifies the percentage of the line_base_units billed. DEPRECATED
brd_arrow.gif description string The long description of this line, used when printing or otherwise displaying invoices DEPRECATED
brd_arrow.gif date_range_start string The starting date range for the item or plan on this line DEPRECATED
brd_arrow.gif date_range_end string If any, the ending date range for the item or plan on this line. DEPRECATED
brd_arrow.gif credit_coupon_code string Specifies the coupon code applied to the invoice. DEPRECATED
brd_arrow.gif plan_no long The unique ID plan this line represents DEPRECATED
brd_arrow.gif plan_name string The name of the plan this line represents DEPRECATED
brd_arrow.gif client_service_id string Client-defined unique service identifier. DEPRECATED
brd_arrow.gif client_plan_id string Client-defined unique Plan Identifier DEPRECATED
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_credit_result_amount double The total pro-rated credit amount
proration_credit_amount double The non-tax pro-rated credit amount
proration_tax_amount double The pro-rated tax credit amount
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.
Powered by CXone Expert ®