assign_custom_acct_plan_rates_m
Applies custom rates to a particular plan instance and service assigned to a specified account. Please note: Custom rates can be assigned to only recurring and usage-based services.
For information on error messages generated by this API, see assign_custom_acct_plan_rates_m Error Messages.
Input Arguments
Req | Field Name | Field Type | Max Length | Description | ||||||
---|---|---|---|---|---|---|---|---|---|---|
![]() |
client_no | long | 22 | Aria-assigned unique identifier indicating the Aria client providing service to this account. | ||||||
![]() |
auth_key | string | 32 | Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor. | ||||||
![]() |
acct_no | long | 22 | Aria-assigned account identifier. This value is unique across all Aria-managed accounts. | ||||||
OR | ||||||||||
client_acct_id | string | 50 | Client-defined account identifier. | |||||||
![]() |
plan_instance_no | long | Unique plan instance number for each custom rate. | |||||||
OR | ||||||||||
client_plan_instance_id | string | 100 | Unique client-defined ID for each custom rate. | |||||||
Start of custom_acct_rates array | ||||||||||
![]() |
custom_acct_rates | array | This is a multidimensional array containing elements with the attributes rate_seq_no, rate_per_unit, from_unit, to_unit. | |||||||
Field Name | Field Type | Max Length | Description | |||||||
![]() |
long | The Aria-assigned rate sequence number for this rate schedule | ||||||||
double | The rate per unit value for this rate schedule | |||||||||
long | The beginning of the rate tier volume of units for this rate_per_unit | |||||||||
long | The end of the rate tier volume of units to relevant to this rate_per_unit | |||||||||
End of custom_acct_rates array | ||||||||||
service_no | long | 22 | Aria-assigned unique service identifier | |||||||
OR | ||||||||||
client_service_id | string | 100 | A multidimensional array of Client-defined Service ID for this plan. | |||||||
alt_caller_id | string | 30 | Person or process that submitted the API call. This can be someone's user ID, or the name of an application. | |||||||
Start of optional_transaction_qualifiers | ||||||||||
optional_transaction_qualifiers | array | Array of additional values you can associate with this API call. | ||||||||
Field Name | Field Type | Max Length | Description | |||||||
string | 100 | Name of the field you want to associate with this API call. | ||||||||
string | 100 | Corresponding value of the field you want to associate with this API call. | ||||||||
End of optional_transaction_qualifiers | ||||||||||
application_id | string | 300 | The application identifier in which the API is being used in. (Example: “Sales Force”) | |||||||
application_date | string | 300 | The application date/timestamp, ie. 01/01/2014 10:00:00 to track when the application called the API. | |||||||
plan_scope | string | 1 |
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:
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 for plan_scope:
|
|||||||
plan_queue_id | long | 22 |
Unique identifier associated with a specific queued plan change. The plan_queue_id input will be ignored if you do not pass Q into the plan_scope field. |
Output Arguments
Field Name | Field Type | Description |
---|---|---|
error_code | long | Aria-assigned error identifier. 0 indicates no error. |
error_msg | string | Description of any error that occurred. "OK" if there was no error. |