Skip to main content
Aria Knowledge Central

update_acct_plan_unit_instance_m

  1. Last updated
  2. Save as PDF

Summary

API Name update_acct_plan_unit_instance_m
Class account_services_m
Update Version 53

Description

This API can be used to either update fulfillment, or the supplemental field(s) on the unit instances of a plan.

Inputs

Name Type Length Required Description
client_no long 22 Yes

Aria-assigned unique identifier indicating the Aria client providing service to this account.
auth_key string 32 No

Aria-assigned unique key for authenticating the validity of the requestor. This key is passed with each method call.
acct_no long 22 Yes

Aria-assigned account identifier. This value is unique across all Aria-managed accounts.

Alternative required field: client_acct_id
client_acct_id string 50 Yes

Client-defined account identifier.

Alternative required field: acct_no
plan_unit_inst_no long 100 Yes

Aria unique Plan Unit Instance Number.

Alternative required field: client_plan_unit_inst_id
client_plan_unit_inst_id string 100 Yes

Client-assigned identifier for the plan unit instance.

Alternative required field: plan_unit_inst_no
new_client_plan_unit_inst_id string 100 No

New client-assigned identifier for the plan unit instance, which will replace the existing client-assigned identifier currently on the plan unit instance.'
plan_unit_instance_services object   No

This return value of array of plan unit instance.

See fields below
plan_unit_inst_fields object   No

Array of client-defined plan unit instance fields.

See fields below
do_write string 5 No

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'

Allowed values:

Value Description
True  
False  
proration_invoice_timing long 1 No

Determines whether to create a separate invoice for prorated charges immediately, or defer to the next anniversary date. Note that this will override the Proration Invoice Timing configuration saved with the plan in the product catalog.

Allowed values:

Value 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.
recurring_processing_model_ind long 1 No

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.

Allowed values:

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

plan_unit_instance_services fields

Name Type Length Required Description
service_no long 22 No

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

Alternative field: client_service_id
client_service_id string   No

Client-assigned identifier for the service.

Alternative field: service_no
service_fulfillment_date string 10 No

It is a Fulfillment completion date. It can be in past, today or future date.
fulfillment_directive long 1 No

This derives whether the fulfillment date should be assigned/modified or removed from the fulfillment based service on then plan unit instance.

Allowed values:

Value Description
1 Complete fulfillment with immediate affect. This would be accomplished by specifying fulfillment date in past or today or without any fulfillment date. (default)
2 Complete fulfillment with effective date specified in future. A user must specify service_fulfillment_date with this directive.
3 Remove the already assigned fulfillment date.

plan_unit_inst_fields fields

Name Type Length Required Description
field_name string 100 No

Field name of plan unit instance field
field_value string 1000 No

The value stored under this field
plan_unit_inst_directive long 1 No

The directive is mandatory if field name/value pair are specified.

Allowed values:

Value Description
1 Add Value
2 Replace Value
3 Remove Value

Outputs

Name Type Length Required Description
error_code long   No

Aria-assigned error identifier. 0 indicates no error.
error_msg string   No

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

Aria generated unique identifier for the account
out_client_acct_id string   No

This is the client-assigned identifier for the account.
out_plan_unit_inst_no long   No

Aria unique Plan Unit Instance Number.
out_client_plan_unit_inst_id string   No

Client-assigned identifier for the plan unit instance.
proration_result_amount double   No

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 fulfillement based plan unit instance were to be actually assigned.
invoice_no long   No

The Aria-assigned unique identifier of a given invoice.
invoice_line_items object   No

See fields below
collection_error_code long   No

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

The error message associated with collection_error_code.
statement_error_code long   No

The error code generated when attempting to create the statement resulting from this call, if any
statement_error_msg string   No

The text message associated with 'statement_error_code'
proc_cvv_response string   No

The processor return code from CVV validation.
proc_avs_response string   No

Processor return code from address validation
proc_cavv_response string   No

The processors return code for security validation.
proc_status_code string   No

The processor status code
proc_status_text string   No

The processors status description
proc_payment_id string   No

The processor payment id
proc_auth_code string   No

Authorization code provided by the issuing bank
proc_merch_comments string   No

Additional information passed to payment processor
proc_initial_auth_txn_id string 100 No

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.
total_charges_before_tax double   No

Total amount to be charged to the account before taxes have been calculated.
total_tax_charges double   No

Total taxes as calculated for the amount of the transaction.
total_charges_after_tax double   No

Total amount to be charged to the account after taxes have been calculated.'
total_credit double   No

The total amount of the credit to be applied to the account
total_tax_credit double   No

The tax amount of the credit to be applies
total_credit_before_tax double   No

The credit to be applied before tax is taken into account
total double   No

The grand total of this invoice
expectd_monthly_rec_cost double   No

The predicted monthly recurring cost of the items and plans on this invoice
expectd_annual_rec_cost double   No

The predicted annual recurring cost of the items and plans on this invoice
third_party_errors object   No

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

See fields below
proc_payment_response_field_list object   No

Payment response fields returned by the processor for further actions if any.

See fields below

invoice_line_items fields

Name Type Length Required Description
service_no     No  
units     No  
amount     No  
base_plan_units     No  
client_service_id     No  

third_party_errors fields

Name Type Length Required Description
error_class string   No

Type of error code, such as taxation.
error_code string   No

Error code returned by the third-party system.
error_msg string   No

Error message returned by the third party system.

proc_payment_response_field_list fields

Name Type Length Required Description
proc_payment_response_field_name string 100 No

Field name of various response returned by the processor, example: micro_deposit_verify_url.

Allowed values:

Value Description
micro_deposit_verify_url The URL returned by the processor to share with the customer to validate their bank information and perform the micro deposits.
proc_payment_response_field_value string 4000 No

Field value for the corresponding payment response field, example: Actual URL to be used for the micro deposit verification.
TOP
  1. Back to top
  • Was this article helpful?

Recommended articles

  1. Page type
    Topic
  2. Tags
    This page has no tags.