Modifying delinquency plans

PATCHing delinquency plans

Use the following endpoint to PATCH an existing delinquency plan:

  • PATCH /delinquency-plans/{delinquencyPlanId}

When a delinquency plan is assigned to at least one account or 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 delinquency plan bc:202 so that grace period is calculated in calendar days and the plan expires on June 6, 2025.

  • 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/delinquency-plans/bc:202

{
  "data": {
    "attributes": {
        "expirationDate": "2025-06-06",
        "gracePeriodDayUnit": {
            "code": "calendar"
        }
    }
  }
}

There are a separate set of endpoints for PATCHing a delinquency plan's workflows. For more information, see Delinquency plan workflows.

DELETEing delinquency plans

Use the following endpoint to DELETE an existing delinquency plan:

  • DELETE /admin/v1/delinquency-plans/{delinquencyPlanId}

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

For example, the following deletes delinquency plan bc:202 (assuming that it is not in use).

DELETE /admin/v1/delinquency-plans/bc:202

<no request body>

There are a separate set of endpoints for DELETEing a delinquency plan's workflows. For more information, see Delinquency plan workflows.