modify_acct_plan_unit_instances_m Guide
- Last updated
-
-
Save as PDF
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.
| API Specification: |
modify_acct_plan_unit_instances_m |
| Required Fields: |
- <client_no>
- <auth_key>
- <acct_no> or <client_acct_id>
- <plan_instance_no> or <client_plan_instance_id>
|
Additional Guidance
Input Fields
| Field Name |
Notes |
| <assignment_directive> |
Allowable Values
| 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. |
|
| <proration_invoice_timing> |
Allowable Values
| 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> |
Allowable Values
| Values |
Description |
| true |
true |
| false |
false |
|
Output Fields
| Field Name |
Notes |
| <line_type> |
Allowable Values
| 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 |
|
Error Codes
| Error Code/Description |
Associated Inputs |
|
|
|
1004: authentication error
|
<client_no>, <auth_key> |
1009: account does not exist, Account not found: AriaNo (acct_no), Account not found: Userid (userid), or Account not found: ClientId (client_acct_id)
|
<acct_no>, <client_acct_id> |
27011: The API is not supported because your client parameter Enable Plan Unit Instances is set to False. Please contact Aria Customer Support with questions about the Enable Plan Unit Instances client parameter.
|
<client_no> |
14046: If you passed in an invalid plan_instance_no, this message will appear: "Invalid Plan instance number". If you passed in an invalid master_plan_instance_id, this message will appear: "Invalid master_plan_instance_id".
Additional Comments: The plan_instance_no or master_plan_instance_id must belong to the account, or it is invalid. The percent_eval_plan_instance_no must belong to the account and also to the MPI given in input.
|
<plan_inst_no>, <client_plan_inst_id>, <plan_unit_inst_no>, <client_plan_unit_inst_id>, <new_client_plan_unit_inst_id> |
14047: If you passed in an invalid client_plan_instance_id, this message will appear: "Invalid client Plan instance identifier". If you passed in an invalid client_master_plan_instance_id , this message will appear: "Invalid client_master_plan_instance_id".
|
<plan_inst_no>, <client_plan_inst_id>, <plan_unit_inst_no>, <client_plan_unit_inst_id>, <new_client_plan_unit_inst_id> |
1033: a parameter that represents a true or false value contains invalid input
|
<do_write> |
1010: missing required parameters, Missing input: (object-name) is required with assignment_directive ($AriaNo)
|
<client_no>, <auth_key>, <acct_no> or <client_acct_id>, <plan_instance_no> or <client_plan_instance_id>
|
27003: invalid Plan unit instance
|
<plan_unit_inst_no> |
27012: Inactive Plan unit instance
|
<plan_unit_inst_no> |
27004: invalid Plan unit instance id
|
<client_plan_inst_id>, <client_plan_unit_inst_id>, <new_client_plan_unit_inst_id> |
1035: invalid assignment directive, Invalid Assignment Directive: (assignment_directive)
|
<assignment_directive> |
