Skip to main content
Aria Knowledge Central

assign_custom_acct_plan_rates_m Guide

Applies custom rates to a particular plan instance and service assigned to a specified account.

API Specification:

assign_custom_acct_plan_rates_m

Required Fields:
  • <client_no>
  • <auth_key>
  • <acct_no> or <client_acct_id>
  • <plan_instance_no> or <client_plan_instance_id>
  • <custom_acct_rates> (array)
    • <rate_seq_no>
Error Messages:

assign_custom_acct_plan_rates_m Error Messages

Additional Guidance:

Input Fields

Field Name: Notes:
<plan_scope>

This determines whether the rate changes apply to a current plan or a queued (future) plan.

If a customer has a future plan that is already scheduled to be assigned after a rollover from a currently-assigned plan, you can assign custom rates to the future plan. This applies to a future plan assignment set up by:

scheduling a plan change to go into effect on the customer's anniversary date using assignment_directive=1 or master_plan_assign_directive=1 in an API that supports either of those fields (examples: assign_acct_plan_m or update_acct_complete_m); or

adding a subscription to a plan scheduled to roll over to another plan on the customer's anniversary date; or

adding a subscription to a plan scheduled to roll over to another plan on any other chosen date.

Example: You may choose to offer a customer a promotional rate for a future plan as a goodwill gesture or for other business reasons.

To assign custom rates to a future plan, pass values into the plan_scope and plan_queue_id fields.

The plan_queue_id is not required for custom rates that will be applied to a future plan scheduled to be assigned on the customer's anniversary date.

The plan_queue_id input will be ignored if you do not pass Q into the plan_scope field.

Allowable values:

Values Description
C The specified custom rates should be applied to the current plan (default).
Q The specified custom rates should be applied to the queued (future) plan. The plan_queue_id input will be ignored if you do not pass Q into the plan_scope field.
  • Was this article helpful?