cancel_acct_plan_m
Cancels a master or supplemental plan assigned to a specified account. Note that the cancellation of a master or supplemental plan also cancels all its child plans. These child plans however, remain on the account in an unusable state in the event the parent plan is re-activated. When all master plans on an account have a plan status of Canceled, Terminated, or Suspended, the account will be automatically deactivated based on the Days Before Deactivation configuration parameter.
For information on error messages generated by this API, see cancel_acct_plan_m Error Messages.
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. | ||||||||||||||||||||
| OR | ||||||||||||||||||||||||
| client_acct_id | string | 50 | Client-defined account identifier. | |||||||||||||||||||||
| client_receipt_id | string | 50 | Client-defined unique identifier used to track related system actions | |||||||||||||||||||||
|
plan_instance_no | long | 22 | The Master or Supplemental Plans' plan instance number. | ||||||||||||||||||||
| OR | ||||||||||||||||||||||||
|
client_plan_instance_id | string | 100 | The Master or Supplemental Plans' client-defined plan instance number. | ||||||||||||||||||||
| 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. Allowable values for assignment_directive:
|
|||||||||||||||||||||
| comments | string | 500 | Additional explanatory text relating to this API call. | |||||||||||||||||||||
| alt_proration_start_date | string | 10 |
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. Note: If you cancel a master or supplemental plan using this API, the <alt_proration_start_date> must be within the date range of the recurring billing period that was last invoiced. |
|||||||||||||||||||||
| 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 anniversary date. | |||||||||||||||||||||
| invoice_unbilled_usage | string | 5 |
Specifies whether to invoice the unbilled usage if a plan is terminated in the middle of a billing period. Allowable values for invoice_unbilled_usage:
|
|||||||||||||||||||||
| 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:
|
|||||||||||||||||||||
| 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:
|
|||||||||||||||||||||
| 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. | ||||||||||||||||||||||
| string | 100 | Name of the field you want to associate with this API call. | ||||||||||||||||||||||
| 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. | |||||||||||||||||||||
| recurring_processing_model_ind | long | 1 |
Defines a recurring payment type for Credit Card and Tokenized Credit Cards. Allowable values for recurring_processing_model_ind:
|
|||||||||||||||||||||
| include_plan_instance_queue | string | 5 |
Use this field to obtain the list of plan changes that you scheduled using this API. Allowable values for include_plan_instance_queue:
|
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. | ||||||||||||||||||||
| invoice_no | long | The Aria-assigned unique identifier of a given invoice. | ||||||||||||||||||||
| acct_plan_line_items | hash | |||||||||||||||||||||
| long |
Specifies the type of charge or credit associated with this line item. Allowable values for line_type:
|
|||||||||||||||||||||
| 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. | |||||||||||||||||||||
| 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. | |||||||||||||||||||||
| 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. | |||||||||||||||||||||
| 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_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 | ||||||||||||||||||||
| 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. | ||||||||||||||||||||
| string | The type of error code being represented, such as taxation | |||||||||||||||||||||
| string | The error code returned by the third party system | |||||||||||||||||||||
| string | The error message returned by the third party system | |||||||||||||||||||||
| 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. |