adjust_acct_plan_billing_dates_m
Adjusts the billing date for a specified set of master plans under one or more accounts to date(s) in the future or in the past. You can adjust billing dates for plans with a daily, weekly, monthly, or any other billing interval.
Note: When you call this API, Aria will not preform proration. Examples:
- If you move a plan's billing date 15 days forward, Aria will not collect recurring charges for the additional 15 days.
- If you move a plan's billing date backward, Aria will double-bill for the recurring charges that apply to the overlapping period.
For information on error messages generated by this API, see adjust_acct_plan_billing_dates_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. | |||||||||
| Start of billing_dates array | ||||||||||||
| billing_dates | array | Array of master plan instances associated with the account for which billing data is to be modified | ||||||||||
| Field Name | Field Type | Max Length | Description | |||||||||
|
long | 22 | The unique identifier of the plan instance. | |||||||||
| OR | ||||||||||||
| string | 100 | The client-defined identifier of the plan instance. | ||||||||||
|
long | Determines whether the billing date is adjusted forward or backward.
Allowable values for action_directive:
|
||||||||||
| long | 4 |
Number of days to adjust the billing date. The number of days cannot exceed 27 days before or after the current next billing date. This applies regardless of the master plan's or any associated supplemental plan's billing interval. This field is required if <action_directive> is set to 1 or 2. |
||||||||||
| OR | ||||||||||||
| string | 10 |
The date to set the next billing date. The adjustment date cannot exceed 27 days before or after the current next billing date. This applies regardless of the master plan's or any associated supplemental plan's billing interval. This field is required if <action_directive> is set to 3. Note: These rules apply to <adjustment_days> and <adjustment_date>:
|
||||||||||
| End of billing_dates array | ||||||||||||
| comments | string | Additional explanatory text relating to this API call. | ||||||||||
| 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 array | ||||||||||||
| 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 array | ||||||||||||
| 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. | |||||||||
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. |