Modifying payment plans

PATCHing payment plans

Use the following endpoint to PATCH an existing payment plan:

  • PATCH /admin/v1/payment-plans/{paymentPlanId}

When a payment 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 the expirationDate can be modified.

For example, the following changes payment plan bc:1001 so that the maximum number of installments is 8 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/payment-plans/bc:1001

{
  "data": {
    "attributes": {
        "expirationDate": "2025-06-06",
        "maximumNumberOfInstallments": 8
    }
  }
}

DELETEing payment plans

Use the following endpoint to DELETE an existing payment plan:

  • DELETE /admin/v1/payment-plans/{paymentPlanId}

When a payment 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 payment plan bc:1001 (assuming that it is not in use).

DELETE /admin/v1/payment-plans/bc:1001

<no request body>