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

 

Home > Aria6 core api > cancel_supp_plan

cancel_supp_plan

Cancels the supplemental plans assigned to a specified account.

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 38 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
  supp_plan_no long 22 Aria-assigned identifier for a supplemental service plan. Allowable values are limited to valid custom plan numbers for the client.
  OR      
  client_supp_plan_id string 100 Client-defined supplemental plan ID.
  comments string 300 Additional explanatory text relating to this API call.
  do_write string 5 Indicates whether to perform the requested plan assignment/de-assignment. If 'false' Aria, if applicable, calculates any potential proration effect that would result and return that value in the output field 'proration_result_amount' without actually performing the requested operation or charging/crediting the account. Used for interfaces that return a 'confirmation page' informing of the effects of the requested operation before actually performing it.   Allowable Values
  client_receipt_id string 50 Client-defined unique identifier used to track related system actions
  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.
  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 whether to invoice unbilled usage.   Allowable Values
  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 is either 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.
invoice_no long Unique identifier of a given invoice.
supp_plan_line_items hash  
line_no long Specifies the sequential line number of this line item. Initial record value is always 1.
line_type long Specifies the type of charge or credit associated with this line item.
service_no long Specifies the Aria-assigned unique service identifier.
service_name string Specifies the name corresponding to this line item's service code.
line_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.
rate_per_unit double Specifies the rate per unit billed.
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 Specifies the description of this line item.
date_range_start string Specifies the start date of the date range covered by this line item in yyyy-mm-dd format.
date_range_end string Specifies the end date of the date range covered by this line item in yyyy-mm-dd format.
credit_coupon_code string Specifies the coupon code applied to the invoice.
plan_no long Specifies the Aria-assigned service plan number under which this line item was billed.
plan_name string Specifies the name of the service plan associated with the plan_no.
client_service_id string A multidimensional array of client defiend Service id for this plan.
client_plan_id string Client defined Plan ID for which to query available child plans
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 Total amount of the credit to be applied to the account
total_tax_credit double Tax amount of the credit to be applies
total_credit_before_tax double Credit to be applied before tax is taken into account
total double Total of this invoice
proration_credit_result_amount double The total proration credit granted to the account
proration_credit_amount double The non-tax proration credit granted to the account
proration_tax_amount double Prorated refund of the initial tax amount
client_service_id string A multidimensional array of client-defined Service ID for this plan.
client_plan_id string Client-defined Plan ID
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
10:48, 9 May 2017

Tags

This page has no custom tags.

Classifications

This page has no classifications.