Search the Aria Knowledgebase for
User Documentation, APIs, SDKs, and more!

 

Home > Aria6 core api > update_master_plan

update_master_plan

Changes the master plan assigned to a specified account holder. This call also has the ability to cancel the supplemental plans associated with the account holder's previous master plan.

Input Arguments

Req Field Name Field Type Max Length Description
client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
auth_key string 32 Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.
acct_no long 22 Aria-assigned account identifier. This value is unique across all Aria-managed accounts..
assignment_directive long 8 Rule to apply to this assignment/de-assignment request, specifying: the date the assignment takes place (immediately or on the account's anniversary date), and the proration rule to apply (per client's default rules for proration, that is, prorate on plan assignment or force proration on or off for each request). Default is to assign plan on the anniversary date, resulting in no proration effect.   Allowable Values
master_plan_no long 22 The Master Subscription plan number.
OR
client_master_plan_id string 100 Client-defined Master plan Subscription plan ID.
alt_rate_schedule_no long 22 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 number to assign (if any). If none is specified, the default rate schedule number will be used.
num_plan_units long 38 The factor by which all future recurring fees for this plan will be multiplied on future invoices for this account. EXAMPLE: An account wishes to have the supplemental plan titled Seats of XYZ Application assigned to them, with a monthly flat cost of $10.00 per seat. To assign 5 seats of this plan to the account, resulting in a monthly charge of $50.00 to the account, a value of 5 should be passed in this field.
do_write string 5 Boolean indicator informing Aria whether or not to actually perform the requested plan assignment /de-assignment. If 'false' is passed in this field Aria will, if applicable, calculate any potential proration effect that would result from this call and return that value in the output field 'proration_result_amount' described below without actually performing the requested operation or charging/crediting the account. This is useful to interfaces that wish to present the user with a 'confirmation page' informing of the would-be effects of the requested operation prior to actually performing it.   Allowable Values
client_receipt_id string 50 Client-defined unique identifier used to track related system actions
force_currency_change string 5 Force currency change during update. Generally this is necessary when the update is taking place to accommodate for an account holder moving from one area to another where the local currency is different.   Allowable Values
auto_cancel_supp_plans string 5 This boolean asserts that supplemental plans are automatically cancelled if necessary.   Allowable Values
offset_months long 8 Number of months to add to the prorated period.
alt_proration_start_date string 14 The date, in yyyy-mm-dd format, from which the proration calculations begin. If this field is NULL, then the proration calculations begin from the current date. This date cannot be before the beginning of the current billing period.
alt_client_acct_group_id string 100 The one-time collections account group for this account for this API call only
new_acct_custom_rates array
custom_rate_plan_no long Unique identifier for the plan to which this custom rate is to be applied for this account.
OR
client_custom_rate_plan_id string 100 The unique identifier defined by client for the plan to which this custom rate is to be applied for this account.
custom_rate_service_no long 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
client_custom_rate_service_id string 100 The unique identifier by client the service ID to determine which custom rate is to be applied for this account.
custom_rate_seq_no long Rate tier number to which this custom rate is to be applied.
custom_rate_from_unit long 38 Starting unit of a range of units to which this custom rate is to be applied.
custom_rate_to_unit long 38 Ending unit of a range of units to which this custom rate is to be applied.
custom_rate_per_unit double 38 Custom rate per unit.
effective_date string 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 1000 If assigning a change on an anniversary day, the number of billing periods by which to delay that change
invoice_unbilled_usage string 5 Specifies the unbilled usage to be invoiced or not.   Allowable Values
coupon_code string 30 A coupon code to apply to this account
surcharge_no array
surcharge_no long The Surcharge number to be attached to the plan
rate_schedule_no long The Schedule number for this surcharge
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.
optional_transaction_qualifiers array Array of additional values you can associate with this API call.
qualifier_name string 100 Name of the field you want to associate with this API call.
qualifier_value string 100 Corresponding value of the field you want to associate with this API call.
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.

Output Arguments

Field Name Field Type Description
error_code long Aria-assigned error identifier. 0 indicates no error.
error_msg string 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 unique identifier of a given invoice.
cancelled_supp_plans hash An array containing the supplemental plans cancelled.
supp_plan_no long The unique ID of the supplemental plan
supp_plan_name string The name of the supplemental plan
supp_proration_result_amount double The result of the pro-ration calculation for the unused portion of the billing period
client_supp_plan_id string Client-defined supplemental plan ID.
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
upd_acct_invoice_line_items hash
line_no long The line number on the initial invoice
line_type long Specifies the type of charge or credit associated with this line item.  Allowable Values
service_no long The unique ID for the service this line represents
service_name string The name of the service this line represents
line_units double The number of units of the item or plan on this line
rate_per_unit double The charge per unit of the item or plan on this line
line_amount double Specifies the total charge associated with this line item.
line_base_units double Specifies the full, non-prorated number of units of the service code.
proration_factor double Specifies the percentage of the line_base_units billed.
description string The long description of this line, used when printing or otherwise displaying invoices
date_range_start string The starting date range for the item or plan on this line
date_range_end string If any, the ending date range for the item or plan on this line.
credit_coupon_code string Specifies the coupon code applied to the invoice.
plan_no long The unique ID plan this line represents
plan_name string The name of the plan this line represents
client_service_id string Client-defined unique service identifier.
client_plan_id string Client-defined unique Plan Identifier
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
third_party_errors hash 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.
error_class string Type of error code being represented, such as taxation
error_code string Aria-assigned error identifier. 0 indicates no error.
error_msg string Description of any error that occurred. "OK" if there was no error.

You must to post a comment.
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.