Modifying and deleting return premium plans

Modifying return premium plans

Use the following endpoint to PATCH an existing return premium plan:

  • PATCH /admin/v1/return-premium-plans/{returnPremiumPlanId}

When a return premium plan is assigned to at least one policy, BillingCenter considers the plan to be in use. When a plan is not in use:

  • Its inUse field is set to false.
  • The entire plan can be modified.

When a plan is in use:

  • Its inUse field is set to true.
  • Through Cloud API, only expirationDate and planOrder can be modified.

For example, the following changes the effective date of return premium plan bc:200 to March 3, 2023.

  • If the plan is not in use, the PATCH is successful.
  • If the plan is in use, the PATCH fails because it specifies a value that is not expirationDate.
PATCH /admin/v1/return-premium-plans/bc:200

{
  "data": {
    "attributes": {
        "effectiveDate": "2023-03-03",
    }
  }
}

Deleting return premium plans

Use the following endpoint to DELETE an existing return premium plan:

  • DELETE /admin/v1/return-premium-plans/{returnPremiumPlanId}

When a return premium plan is assigned to at least one policy, BillingCenter considers the plan to be in use. When a plan is in use, it cannot be deleted.

For example, the following deletes return premium plan bc:200 (assuming that it is not in use).

DELETE /admin/v1/return-premium-plans/bc:200

<no request body>