Change Billing Frequency

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Overview

Changes the billing frequency on a bound policy. This reschedules all pending invoices to match the new frequency, archives the old invoices, reallocates any existing payments, and optionally recalculates installment fees.

What this endpoint does:

  1. Loads the policy by policyID
  2. Validates the frequency change is allowed (permission, dates, existing payment state, valid frequency)
  3. Archives all pending invoices and deallocates payments
  4. Creates new invoices on the new billing schedule
  5. Reallocates any previously allocated payments
  6. Recalculates installment fees if the rating program uses per-installment fees
  7. Updates pending endorsements and book/page policy schedules if applicable
  8. Fires a BillingFrequencyChanged event

Preconditions: User must have Edit (Policy) and Create (MemberTransaction) permissions. New frequency must differ from current. Transaction date must be before expiry. Pending bills must exist. For account-level billing, pending invoices must not have allocated payments.

Side effects: Archives old invoices, creates new schedule, reallocates payments, recalculates fees if applicable, updates pending endorsements and PEL structures, fires BillingFrequencyChanged event.

Returns: RequestMethodResponse with IsSuccessful = true and RecordID = the policyID.

Path Params
integer
required

The ID of the bound policy for which you are changing the billing frequency.

Query Params
string
enum
required
Defaults to O

The new billing frequency code (case-insensitive). See valid codes below.

CodeDescription
OOne Time
AAnnual
BBi-Annual
QQuarterly
MMonthly

Not all codes may be available for every policy. Valid options depend on the policy's payment schedule configuration. If an invalid code is provided, the error message lists the valid options.

Allowed:
date-time

The effective date of the change. Defaults to today if omitted. ISO 8601 (YYYY-MM-DD) format.

Response

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json