replace_acct_plan_m Guide

Last updated
Save as PDF

This API is used to replace an existing master or supplemental plan with a new master or supplemental plan for a specified account.

API Specification:	replace_acct_plan_m
Required Fields:	<client_no> <auth_key> <acct_no> or <client_acct_id> <plan_instance_no> or <client_plan_instance_id> <new_plan_no> or <new_client_plan_id>

Error Codes


1001: unexpected error
1004: authentication error Associated Inputs: auth_key, client_id, client_no
1009: account does not exist, Account not found: AriaNo (acct_no), Account not found: Userid (userid), or Account not found: ClientId (client_acct_id) Associated Inputs: acct_no, account_no, client_acct_id, user_id, userid, parent_acct_no
1010: missing required parameters, Missing input: (object-name) is required with assignment_directive ($AriaNo) Associated Inputs: all required inputs, typically one of the following: custom_rate_per_unit, custom_rate_seq_no, status_cd, dunning_state, userid, acct_no, client_acct_id, assignment_directive, billing_group_no, client_billing_group_id, threshold_billing_rule_no, client_threshold_billing_rule_id Alternate Message Output 1010: username is required 1010: first name is required 1010: last name is required 1010: email is required 1010: roles are required Associated APIs: create_user_m, get_user_details_m, delete_user_m, update_user_m Associated Inputs: username, first_name, last_name, email, role_no
1024: invalid date format Associated Inputs: bill_birthdate, birthdate, degrade_date, initial_credit_date, invoice_line_reversing_date, service_fulfillment_date, queue_date, start_bill_date, end_bill_date, start_date, end_date, stmt_birthdate, bill_birthdate Additional Comments: All date inputs must be in yyyy-mm-dd format.
1033: a parameter that represents a true or false value contains invalid input Associated Inputs: alt_collect_on_approve, alt_send_statement_on_approve, cancel_orders_on_discard, cascade_action, do_auto_discard, do_collect, change_status_after_coll, reset_dates_after_status, disable_existing_on_update, do_write, exclude_terminated_plan_inst, include_all_rate_schedules, include_plan_hierarchy, retrieve_bundled_nso, retrieve_included_nso, include_translations, include_inactive_items, include_invoice_activity_eligibility, include_rs_summary, include_translations, include_service_supp_fields/include_product_fields/, include_plan_instance_fields/include_plan_services/, include_surcharges, include_void_transactions, include_voided, invoice_unbilled_usage, is_unlinked_refund, record_cc_on_auth_failure, retrieve_excluded_usage, send_email, usage_pooling, do_write
1034: there is no data to be modified
1035: invalid assignment directive, Invalid Assignment Directive: (assignment_directive) Associated Inputs: master_plan_assign_directive, assignment_directive
1049: Billing or Plan changes not allowed due to the account status, Cannot add assignment for account with status code -99, Cannot add assignment for account with status code 0 Associated Inputs: N/A Additional Comments: This message indicates a processing problem.
1064: Invalid surcharge directive Associated Inputs: surcharge_directive
1101: Credit-only proration is not valid in this case because there is a mandatory child Supplemental Plan that will be assigned and result in charges on the account. Associated Inputs: master_plan_assign_directive
3017: pro-ration period cannot be greater than Plan billing interval
3018: invalid automatic offset months option
4027: Changes for this Plan were not saved because the collection attempt associated with this change was unsuccessful. Associated Inputs: do_collect
5060: Invalid Product Field Directive. Associated Inputs: plan_instance_field_directive
5053: Missing values for required Plan instance field Associated Inputs: plan_instance_field_value Additional Comments: This field is required, but did not have a value.
5052: Product field is not mapped to the Plan you have specified. Alt: Invalid product field Associated Inputs: plan_instance_fields_info.field_name, field_name Additional Comments: The field is not mapped to the Plan.
5059: Invalid Product Field Value. Associated Inputs: field_value Additional Comments: The value must be from the configured allowed values.
5061: Number of Product Field value exceeds maximum number of allowed values. Associated Inputs: field_value Additional Comments: The value must meet the configured maximum values.
5062: Number of Product Field values does not meet required minimum number of values. Associated Inputs: field_value Additional Comments: The value must meet the configured minimum values.
5063: Field cannot be added because it is not a Plan instance field. Associated Inputs: plan_instance_field_name
7035: The Plan selected for update is a Master Plan. The force_master_bill_date_reset input can only be used in conjunction with Supplemental Plans. Please clear the value of force_master_bill_date_reset or input a Supplemental Plan. Associated Inputs: force_master_bill_date_reset
7036: The Plan selected for update is a Supplemental Plan. The force_bill_date_reset input can only be used in conjunction with Master Plans. Please clear the value of force_bill_date_reset or input a Master Plan. Associated Inputs: force_bill_date_reset
12010: Client account group does not exist Associated Inputs: collections_acct_group_no, client_acct_group_id, alt_client_acct_group_id
14004: Invalid_plan_no Associated Inputs: new_plan_no, rollover_plan_no
14005: invalid Plan service combination Associated Inputs: custom_rate_service_no, custom_rate_service_id Additional Comments: The given Plan number and service number combination for master and Supplemental Plans is not valid.
14006: invalid rate schedule no Associated Inputs: acct_rate_schedule_no, mpi_rate_schedule_no, master_plans_detail, alt_rate_schedule_no, supp_plan.alt_rate_schedule_no
14008: account has Supplemental Plans that are not eligible under this Master Plan Additional Comments: The Supplemental Plan is not linked to the Master Plan.
14012: Alternate rate schedule's currency does not match the account's currency. Associated Inputs: alt_rate_schedule_no, client_alt_rate_schedule_id Additional Comments: The alt_rate_schedule currency does not match the account currency.
14013: New Plan does not have a rate schedule with a currency matching the account's currency. Associated Inputs: alt_rate_schedule_no, acct_currency Additional Comments: The given rate schedule currency does not match the account's currency.
14014: When entering custom rates, the end sequence number of one tier must immediately precede the start sequence number of the next tier. Alt: invalid rate tier structure Associate Inputs: custom_rate_to_unit, custom_rate_seq_no Additional Comments: When entering custom rates, the tiers must be continuous, that is, the end sequence number of one tier must immediately precede the start sequence number of the next tier. In addition, the rate schedule must have the same number of units in each tier, and the same number of tiers, as the schedule on which it is based. From_units must be greater than - and less than to_units.
14015: The custom rates for services other than usage and recurring types can have only one tier with rate_seq_no set to 1, the from_unit set to 1 and to_unit left empty. Alt: custom from and to units not supported for given service_no Associated Inputs: custom_rate_from_unit, custom_rate_to_unit Additional Comments: For the custom rate sequence, the "from" unit in one tier is not immediately after the end unit in the previous tier. Tiers are not allowed for other than recurring and usage services.
14019: usage_accumulation_reset_months must be from 0 to 99 Alt: invalid usage accumulation reset months value Associated Inputs: usage_accumulation_reset_months Additional Comments: The accumulation months is not between 0 and 99.
14022: Supplemental Plan violates Plan exclusion group Associated Inputs: plan_no Additional Comments: The Supplemental Plan is not matched with the Master Plan exclusion group.
14023: Offset Interval must be greater than zero Associated Inputs: offset_interval
14024: Invalid Offset Interval and Assignment Directive combination. Associated Inputs: offset_interval, assignment_directive Additional Comments: Offset_interval only applies to the anniverary date.
14025: Invalid do_write and assignment directive combination for queuing Plan. Associated Inputs: assignment_directive, do_write Additional Comments: Preview cannot be done for queued anniversary date cases.
14026: The Effective Date must be in the future, "YYYY-MM-DD" format, and a valid date. Associated Inputs: effective_date
14027: The end units of final rate tier is not infinity Associated Inputs: custom_rate_to_unit Additional Comments: The custom rates final unit must be infinity.
14033: Invalid Promo Code Associated Inputs: promo_cd
14035: Invalid client Plan id Associated Inputs: client_plan_id, custom_rate_client_plan_instance_id
14036: Invalid client service id Associated Inputs: client_service_id, client_plan_instance_service_id, client_percent_eval_service_id, custom_rate_client_service_id
14039: Invalid client rate schedule id Associated Inputs: client_alt_rate_schedule_id, rollover_client_rate_sched_id
14043: Invalid Plan instance rate_seq combination Associated Inputs: custom_rate_from_unit, custom_rate_to_unit Additional Comments: If the from/to units are not specified, the given rate_seq_no must be a valid rate_seq_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". Associated Inputs: plan_instance_no, master_plan_instance_id, filter_plan_instance_no, percent_eval_plan_instance_no, client_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.
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". Associated Inputs: client_plan_instance_id, client_master_plan_instance_id, client_percent_eval_plan_instance_id
14060: Plan cannot be replaced because the Plan stauts of the existing lan does not allow the Plan to be replaced Additional Comments: The current status of the MPI does not allow its Plan to be replaced
14063: duplicate Plan instance client defined id. Associated Inputs:client_plan_instance_id, new_client_plan_inst_id
14075: Supplemental Plan not eligible under this Plan instance. Associated Inputs: new_plan_no
14077: Account status not support Plan provisioning. Associated Inputs: status_cd Additional Comment: The current status of the account does not allow provisioning.
14079: Supplemental Plan instance status not support Plan provisioning. Associated Inputs: supp_plan.status_cd
14086: Plan Units cannot be below the minimum required units for this child Plan. Associated Inputs: plan_units
14087: The maximum number of allowable units has been exceeded.
14098: Invalid proration invoice timing Associated Inputs: mp_proration_invoice_timing, proration_invoice_timing
14101: Mandatory child Plans cannot be replaced unless their parent Plan is also modified.
14107: Invalid Service Number. Associated Input: custom_rate_service_no
14112 Cannot update/replace/cancel any queued Plan instance which is in queued assignment Associated Inputs: plan_instance_no, client_plan_instance_id
14129: Rate per unit cannot be negative. Associated Input: rate_per_unit
14136: Offset months must be greater than or equal to 0.
14300: Cannot force currency change while account has Master Plan / Supplemental Plans that do not have an available rate schedule in the target currency Associated Input: force_currency_change
14302: Pending Invoices must be discarded prior to forcing a currency change. Associated Input: force_currency_change
14303: Surcharges must be discarded or voided prior to forcing a currency change. Associated Input: force_currency_change
14304: Rated but unbilled usage records must be discarded prior to forcing a currency change. Associated Input: force_currency_change
14305: Discounts (flat rate) or Coupons in an existing currency must be discarded or voided prior to forcing a currency change. Associated Input: force_currency_change
14306: Pending Orders in an existing currency must be discarded or voided prior to forcing a currency change. Associated Input: force_currency_change
14307: Force currency change not allowed with the supplied assignment directive. Associated Input: force_currency_change
14310: Enter a Bill Lag days between +/- Plan's Billing Interval. Additional Comments: Invalid input: For bill lag days, Enter a number between +billing interval and - billing interval days.
14311: Enter a Bill Lag days less than/equal to Plan's Billing Interval. Additional Comments: Invalid input: For bill lag days, Enter a number less than/equal to billing interval days.
14313: There are threshold billing rules attached to this account that will need to be removed prior to changing currency since they are not in the future currency. Associated Input: force_currency_change
14314: There is an active rollover contract for existing currency and it should be cancelled or terminated before proceeding. Associated Input: force_currency_change
14317: Rollover plan does not have an active rate schedule with a currency matching the account's currency.
15001: invalid coupon code Associated Inputs: coupon_codes
15002: coupon expired Associated Inputs: coupon_codes, coupon_cd
15006: Duplicate surcharge number in input Associated Inputs: acct_surcharges, mpi_surcharges, mp_surcharge_no
15008: Invalid surcharge rate schedule no Associated Inputs: rate_schedule_no, mp_rate_schedule_no
15009: Invalid surcharge number Associated Inputs: surcharge_no, mp_surcharge_no
15011: The coupon code provided for this account or Master Plan does not match its specified Coupon Applicability Scope, which determines whether the coupon is available at the account level, the Master Plan Instance level, or both. Associated Inputs: coupon_cd
15012: Coupon code has already been applied and cannot be used again. Associated Inputs: coupon_codes
15013: The surcharge provided for this Account or Master Plan does not match its specified Surcharge Applicability Scope, which determines whether the surcharge is available at the account level, Master Plan Instance level or both. Associated Inputs: mpi_surcharges, mp_surcharge_no
15015: Surcharge can't be assigned because its application scope is payment method Associated Inputs: mpi_surcharges, mp_surcharge_no
16021: The currency for the contract completion rollover target rate schedule must match the currency on the account. Associated Inputs: rollover_rate_sched_no/rollover_client_rate_sched_id
23013: Invalid usage threshold applicability Associated Inputs: usage_threshold_applicability Additional Comments: The usage_threshold_applicability is not in, "ut" or "up".
25020: Illegal characters entered Associated Inputs: All character field inputs like firstname lastname, dunning_group_name, comments, etc.
29001: The service location provided is not valid. Associated Inputs: svc_location_no, item_svc_location_no Additional Comments: The given service location is not available for the client.
29002: The client service location id provided is not valid. Associated Inputs: client_svc_location_id, client_item_svc_location_id Additional Comments: The given service location ID is not available for the client.
29003: The service location provided has been disabled or deleted and cannot be associated with a Plan instance. Associated Inputs: svc_location_no, item_svc_location_no Additional Comments: The given service location must be active.
29005: The contact number provided is invalid for the specified account. Associated Inputs: acct_contact_no, bill_contact_no, stmt_contact_no

Additional Guidance

Input Fields

Field Name:

Notes:

<promo_cd>

For promo code removal, use the alpha erase indicator value '~' (tilde).

<assignment_directive>

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

Values	Description
1	(Default) 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	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.

<alt_proration_start_date>

If you replace a master plan using this API:

When the replaced master plan’s billing interval is the same as the new master plan’s, the <alt_proration_start_date> must be within the date range of the recurring billing period that was last invoiced.
When the replaced master plan’s billing interval is different from the new master plan’s, the <alt_proration_start_date> must be between the start date of the recurring billing period that was last invoiced and the next occurrence of a bill day.

<bill_lag_days>

Examples:

If you want an invoice to be generated 14 days before the billing date, pass -14 into this field.
If you want an invoice to be generated 10 days after the billing date, pass 10 into this field.

By default, bill lag days are restricted to +/- the (minimum number of days in a recurring billing period – 1 day). However, if your Allow Negative Bill Lag Days to Extend Beyond One Bill Cycle parameter is set to True(in the Aria application under Configuration > Billing> Invoice Settings), then the negative value can go beyond a single billing period.

Bill lag days can be removed via APIs update_acct_plan_m, replace_acct_plan_m, update_acct_plan_multi_m and update_acct_complete_m). To remove the MPI bill lag days, pass the standard "numeric erase" indicator of a tilde (~) for <bill_lag_days> input.

Note:

Although ‘-999’ happens to be a valid bill_lag_days value when the your parameter “_Allow Negative Bill Lag Days to Extend Beyond One Bill Cycle_” is “True”, it is obviously not practical as a real value on the APIs as there are not many plausible scenarios where a customer would be invoiced that far in advance.

Aria will set the bill lag days for plans using this order of precedence:

Master plan instance (for a given account)
Collection group setting
Payment terms/payment method setting
Client setting (Configuration > Billing > Bill Lag Days)

Note:

You cannot pass a value into the <bill_lag_days> field by itself. You must also pass in a value to update the plan units, plan status, and/or alternate rate schedule.
<bill_lag_days> cannot be passed in as part of an API call used to schedule changes that will take place on a customer's anniversary date. You must set the <bill_lag_days> to go into effect on a date other than the anniversary date.

Example: If you have an MPI replacement scheduled for a customer's anniversary date, you should not set <bill_lag_days> in the API used for the MPI replacement. If you do, Aria will ignore the <bill_lag_days>.

<proc_field_override> (array)

<transaction_type>

If you use Chase Paymentech or Vantiv, this field allows you to tell that payment gateway which transaction type is involved (examples: single or recurring transaction) when you process a customer's payment information.

This field applies to credit cards and tokenized credit cards. If you don't pass a value into this field, it will default to -1 (use client configuration settings).

Note:

The value that you pass into this field will override the Recurring Optionsthat you set in the Aria application under:
- Configuration > Payments > Payment Gateways > Chase Paymentech/Vantiv > Gateway Options; and
- Configuration > Payments > Collection Groups > Chase Paymentech/Vantiv > Collection Group Options.
Currently, only Chase Paymentech and Vantiv support this field. Other payment gateways might not honor all of the allowable values for this field. You will need to check your payment gateway documentation for confirmation.

Aria will use this order of precedence to determine the transaction type:

value passed into this field
collection group configuration
payment gateway configuration
transaction type that you specified in the <recurring_processing_model_ind> field

Allowable Values

Values	Description
-1	Use client configuration settings for "Send Transaction Type as Recurring for Initial Request Where Possible" or "Send Transaction Type as Recurring for Subsequent Request" as applicable. (default)
1	(Chase) Single transaction mail/telephone order (MOTO) - Designates a transaction where the accountholder is not present at a merchant location and completes the sale over the phone or through the mail. The transaction is not for recurring services or products and does not include sales that are processed via an installment plan.
2	(Chase) Recurring Transaction - Designates a transaction that represents an arrangement between an accountholder and the merchant where transactions are going to occur on a periodic basis.
3	(Chase) Installment Transaction - Designates a group of transactions that originated from a single purchase where the merchant agrees to bill the accountholder in installments.
4	(Chase) Deferred Transaction - Designates a transaction that represents an order with a payment delayed for a specified amount of time.
5	(Chase) Secure Electronic Commerce Transaction - Designates a transaction completed via the Internet at a 3-D Secure capable merchant and in which the accountholder was fully authenticated. (examples: 3-D Secure includes Verified by Visa, Mastercard Identity Check, American Express SafeKey and Discover ProtectBuy.)
6	(Chase) Non-Authenticated Electronic Commerce Transaction - Designates a transaction completed via the Internet at a 3-D Secure capable merchant that attempted to authenticate the accountholder using 3-D Secure (examples: 3-D Secure includes Verified by Visa and Mastercard Identity Check.) Verified by Visa, Mastercard Identity Check, American Express SafeKey and Discover ProtectBuy transactions in the event of: * A non-participating issuer * A non-participating accountholder of a participating issuer * A participating issuer, but the authentication server is not available
7	(Chase) Channel Encrypted Transaction - Designates a transaction between an accountholder and a merchant completed via the Internet where the transaction includes the use of transaction encryption such as SSL (Secure Sockets Layer), but authentication was not performed. The accountholder payment data was protected with a form of Internet security, such as SSL, but authentication was not performed. For Discover, indicates an e-commerce Card Transaction with data protection in which ProtectBuy for Cardholder authentication was not used.
8	(Chase) Non-Secure Electronic Commerce Transaction - Designates a transaction between an accountholder and a merchant completed via the Internet where: * The transaction does not include the use of any transaction encryption such as SSL * Authentication is not performed * An accountholder certificate is not managed.
I	(Chase) IVR Transaction (PINless Debit only) - Designates a transaction where the accountholder completes the sale via an interactive voice response (IVR) system.
R	(Chase) Retail Transaction - Designates a transaction where the accountholder was present at a merchant location.
telephone	(Vantiv) The transaction is for a single telephone order.
mailorder	(Vantiv) The transaction is for a single mail order transaction.

<mp_surcharge_directive>

Allowable Values

Values	Description
1	Apply surcharge to account
2	Remove surcharge from account

<plan_status>

Allowable Values

Values	Description
1	Active
31	Pending Installation
32	Pending Activation
61	Active Non-Billable
41	Trial

<plan_instance_field_directive>

Allowable Values

Values	Description
1	Add name and value for a new plan instance field.'
2	Replace value of an existing plan instance field.
3	Remove the value of an existing plan instance field, note that if the plan instance field is required based on the field definition, the Replace directive should be used.
4	Remove the name and value of an existing plan instance field from the plan instance.

<do_write>

Allowable Values

Values	Description
true	true
false	false

<auto_offset_months_option>

Allowable Values

Values	Description
1	sync to master plan recurring bill thru date
2	sync to old supplemental plan recurring bill thru date (only applies to supplemental plan)

<invoice_unbilled_usage>

Allowable Values

Values	Description
false	Do not allow invoicing the unbilled usage during mid-term plan termination.
true	Allow invoicing the unbilled usage during mid-term plan termination.

<force_master_bill_date_reset>

Allowable Values

Values	Description
	If this value is left empty, the client-level setting (Sync_mstr_bill_dates_on_1st_supp) will take effect.
1	Do not reset master plan billing dates.
2	Reset master plan billing dates if master plan is "free", the account has no "billable" supplemental plans, and the newly-assigned supplemental plan is "billable.
3	Reset master plan billing dates if master plan is "free" and the account has no active supplemental plans.

<usage_pooling>

Allowable Values

Values	Description
true	Usage pooling is enabled for this plan instance.
false	Usage pooling is not enabled for this plan instance. (default)

<usage_threshold_applicability>

Allowable Values

Values	Description
UT	Usage Type
UP	Usage Pool

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

<force_bill_date_reset>

Allowable Values

Values	Description
	Reset the billing dates when the status changes from non-billable to billable depending on client parameter 'AUTO_RESET_MASTER_PLAN_BILLING_DATES_ON_NON_BILLABLE_TO_BILLABLE_MASTER_PLAN_STATUS_CHANGE' setting.
0	Do not reset the billing dates for this plan.
1	Reset the billing anniversary date to coincide with the status change date.
2	Reset the billing anniversary date to coincide with the current anniversary date.

<force_currency_change>

Allowable Values

Values	Description
true	When the plan being updated has a rate schedule with a different currency or the supplied alternate rate schedule has rates defined in different currency, a 'true' value will allow the currency change provided that there are no transactions (or only $0 transaction present) for that account and the new plan/alt rate schedule has the rates defined in the target currency.
false	When the plan being updated has a rate schedule with a different currency the supplied alternate rate schedule has rates defined in different currency, a 'false' value will not allow the currency change.

<recurring_processing_model_ind>

Allowable Values

Values	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. (Default)
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.

<usage_accumulation_reset_months_renewal_option>

Allowable Values

Values	Description
NULL or 1	Recurring / Auto Renew.(Default)
2	Single Use.

<include_plan_instance_queue>

Allowable Values

Values	Description
false	Scheduled plan changes will not be returned in the plan_instance_queue array (default).
true	Scheduled plan changes will be returned in the plan_instance_queue array.

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 charge
8	Order charge
9	Surcharge