| <dunning_state> |
- If you set this field to 1 (in progress), then you can specify one or more of the following dunning options available in these fields:
- <degrade_date>;
- <new_dunning_step>;
- <config_dunning_late_fee_option>; and/or
- <config_dunning_email_option>.
- When you change the <dunning_state> to 0 (none), you should also pass in your chosen<plan_status> for the Master Plan Instance.
Example: you may want to change the Master Plan Instance's status from -1 (suspended) to 1 (active).
- If you set this field to 1 (in progress)but the Master Plan Instance does not have a balance due, then Aria will move the Master Plan Instance out of dunning on the date on which the next dunning step begins.
This applies to Master Plan Instances associated with either payment type: net terms or electronic.
- In addition to self-pay Master Plan Instances, dunning input arguments can now also now be used for parent-pay Master Plan Instances. Also note that when self-pay Master Plan Instance manually enters dunning via this API, all of their parent-pay Master Plan Instances will enter dunning. This is only applicable when entering the dunning. During this special process of entering parent-pay Master Plan Instance, the “config_dunning_late_fee_option and config_dunning_email_option” will only be applicable for self-pay Master Plan Instances and NOT to the parent-pay Master Plan Instance.
|
| <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. |
|
| <do_write> |
Allowable Values
| Values |
Description |
| true |
true |
| false |
false |
|
| <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. |
|
| <dunning_state> |
Allowable Values
| Values |
Description |
| 0 |
None |
| 1 |
In Progress |
|
| <resp_level_cd> |
Allowable Values
| Values |
Description |
| 1 |
Standard Self-Pay: default |
| 2 |
Parent Pay: Usage accrues under self, invoices are generated per self's plan rules BUT are presented for payment against parent account' |
| 3 |
Parent Usage & Pay: Usage accrues under parent and applied only to parent's plan rules and presented to parent for payment' |
|
| <usage_pooling> |
Allowable Values
| Values |
Description |
| true |
Usage pooling is enabled for this plan instance. |
| false |
(default) Usage pooling is not enabled for this plan instance. |
|
| <usage_threshold_applicability> |
Allowable Values
| Values |
Description |
| UT |
Usage Type |
| UP |
Usage Pool |
|
| <mp_surcharge_directive> |
Allowable Values
| Values |
Description |
| 1 |
Apply surcharge to account |
| 2 |
Remove surcharge from account |
|
| <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. |
|
| <plan_instance_supp_field_update_only> |
Allowable Values
| Values |
Description |
| |
This input will not allow plan instance fields to be update for plans that are in a non-provisioned status |
| 0 |
This input will not allow plan instance fields to be update for plans that are in a non-provisioned status |
| 1 |
This input will allow plan instance fields to be update for plans that are in a non-provisioned status |
|
| <force_bill_date_reset> |
Allowable Values
| Values |
Description |
| 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. |
| 3 |
Reset the billing anniversary date to coincide with next future anniversary date by offsetting with its billing interval. |
|
| <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. |
|
| <remove_pi_custom_rates> |
Allowable Values
| Values |
Description |
| true |
Remove the custom rates and use the default rates of the new rate schedule that you assigned. |
| false (default) |
Keep the custom rates currently assigned to the plan instance. |
|
| <config_dunning_late_fee_option> |
Allowable Values
| Values |
Description |
| 1 |
Use dunning process configuration settings (default). |
| 0 |
Do not use dunning process configuration/do not charge late fee. |
|
| <config_dunning_email_option> |
Allowable Values
| Values |
Description |
| 1 |
Use dunning process configuration settings (default). |
| 0 |
Do not use dunning process configuration/do not send email notification. |
|
| <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. |
|
| <transaction_type> |
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. |
|
