When you call this API, Aria will not perform proration. Examples:
adjust_acct_plan_billing_dates_m Guide
The adjust_acct_plan_billing_dates_m API 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.
API Specification: | |
Required Fields: |
|
Additional Guidance
- 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.
Input Fields
Field Name | Notes | ||||||||
---|---|---|---|---|---|---|---|---|---|
adjustment_days |
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. |
||||||||
adjustment_date |
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. These rules apply to <adjustment_days> and <adjustment_date>: For a daily or weekly Master Plan whose billing interval is 27 days or less, the <adjustment_days> or <adjustment_date> cannot exceed the Plan's billing interval -1 day. This applies regardless of the billing interval of any associated Supplemental Plan(s). Example: If you have a 5-day master plan with a billing date of 15 July 2020 and you try to adjust the billing date by +5 days or more, Aria will automatically adjust the billing date to 19 July 2020 (+4 days). You cannot use this API to adjust the billing date of a 1-day Plan. |
||||||||
action_directive |
Determines whether the billing date is adjusted forward or backward. Allowable values
|
Error Codes
Error Code/Description | Associated Inputs |
---|---|
<auth_key>, <client_no> | |
<billing_dates>, <adjustment_date>, <application_date> |
|
<action_directive> | |
<adjustment_days>, <adjustment_date> | |
<adjustment_days> | |
<adjustment_date> | |
<adjustment_days>, <adjustment_date> | |
<adjustment_days> | |
<client_master_plan_instance_id> | |
<client_master_plan_instance_id> |
|
<master_plan_instance_no>, <client_master_plan_instance_id> | |
All character field inputs like <comments>, etc. |