edit_rate_schedule_on_plan_m Sample Call and Response

Last updated
Save as PDF
Share
1. Share
2. Tweet
3. Share

This example edits an existing rate schedule on a plan, updating its name and billing interval settings and adjusting the pricing tier for one service on the schedule, including a scheduled future price increase. It is based on the edit_rate_schedule_on_plan_m definition in methods_m_r73.yml, the Admin Tools API method file for the Aria release 73 build.

This example covers renaming a rate schedule, confirming its billing interval and period type, and updating the current and future pricing tier for one service on that schedule. It does not cover assigning a follow-up rate schedule or restricting the schedule’s general availability window, since neither is part of this particular story.

Sample call

{
  "rest_call": "edit_rate_schedule_on_plan_m",
  "output_format": "json",
  "client_no": 100589,
  "auth_key": "8f3e2c9a1b7d4f6e9c2a5b8d1e4f7a2c",
  "schedule_no": 55012,
  "schedule_name": "Streamline Pro Standard Schedule",
  "client_rate_schedule_id": "RS-STREAM-PRO-STD",
  "is_default": 1,
  "recurring_billing_interval": 1,
  "recurring_billing_period_type": 3,
  "usage_billing_interval": 1,
  "usage_billing_period_type": 3,
  "future_rate": true,
  "future_change_dt": "2026-09-01",
  "service": [
    {
      "service_no": 78301,
      "tier": [
        {
          "from": 1,
          "amount": 19.99,
          "future_amount": 21.99
        }
      ]
    }
  ]
}

The rest_call and output_format fields are REST-layer envelope fields and are not part of the method arguments defined in the yml file itself. client_no and auth_key are the standard Aria-assigned client identifier and authentication key that every call requires.

The schedule_no and schedule_name fields are both required by the yml file and identify and rename the rate schedule being edited. client_rate_schedule_id is an optional client-defined tag for the same schedule. is_default marks this schedule as the default schedule for its currency. recurring_billing_interval, recurring_billing_period_type, usage_billing_interval, and usage_billing_period_type confirm a monthly billing cadence (an interval of 1 combined with a period type of 3, which represents Monthly).

future_rate is set to true and future_change_dt supplies the date the future pricing takes effect, which together allow the tier entry below to specify a future_amount. The service field is a repeatable array; this example includes one entry identifying an existing service on the plan by service_no. Its tier field is also an array, with one tier that starts at unit 1 (the from field), has no upper bound (the optional to field is left out), currently charges 19.99, and is scheduled to increase to 21.99 once future_change_dt arrives.

This example leaves out client_service_id, since service_no already identifies the service, and it leaves out followup_rs_no, client_followup_rs_id, available_from_dt, and available_to_dt, none of which apply to this particular update.

Sample response

{
  "error_code": 0,
  "error_msg": "OK",
  "rate_schedule": {
    "schedule_no": 55012,
    "client_rate_schedule_id": "RS-STREAM-PRO-STD"
  }
}

An error_code of zero with an error_msg of “OK” indicates that Aria successfully edited the rate schedule. The rate_schedule field is a single object, not an array, because a call to edit_rate_schedule_on_plan_m edits exactly one rate schedule at a time; it echoes back the schedule_no and client_rate_schedule_id of the schedule that was edited.