Creating return premium plans

Use the following endpoint to create a return premium plan:

  • POST /admin/v1/return-premium-plans

Minimum creation criteria

When creating return premium plans, you must specify the following:

  • The plan name
  • The plan's effectiveDate
  • The chargeQualification

The chargeQualification field identifies additional criteria to identify the eligible invoice items. It must be set to one of the following values from the ReturnPremiumChargeQualification typelist:

Code Description
Account Same Payer
Policy Same Payer and Policy
PolicyPeriod Same Payer and Policy Period
ChargePattern Same Payer, Policy Period, and Charge Pattern
ChargeCategory Same Payer, Policy Period, and Charge Category
ChargeGroup Same Payer, Policy Period, and Charge Group

For example, the following request creates a new return premium plan.

POST /admin/v1/return-premium-plans/

{
  "data": {
    "attributes": {
        "name": "Same payer and policy period",
        "effectiveDate": "2023-01-01",
        "chargeQualification": {
            "code": "PolicyPeriod"
        }
    }
  }
}

When you create a plan through Cloud API, you cannot specify a planOrder value. BillingCenter automatically sets the new plan's planOrder to "the current highest planOrder value + 1". In other words, new plans are given the highest possible planOrder value (and therefore the lowest priority). However, you can modify a plan's planOrder value through a PATCH.