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