Modifying suspense payments

PATCH suspense payments using the following endpoint:

  • PATCH /billing/v1/suspense-payments/{suspensePaymentId}

You can only PATCH suspense payments that have a status of open. You can only update the following fields when PATCHing suspense payments:

  • amount
  • description
  • The target field: accountNumber or policyNumber

When updating the target field, you can change the existing target field to have a new value, or you can set an entirely new target field. You cannot have more than one target field on a suspense payment.

For example, suppose you have a suspense payment suspense_payment_1 which has a target account accountNumber_1. You could send the following request to update the target to be policy policyNumber_1:

Command
PATCH /billing/v1/suspense-payments/suspense_payment_1
Request body
{
    "data": {
        "attributes": {
            "policyNumber": "policyNumber_1"
        }
    }
}

When you execute this request, the suspense payment no longer has the account as a target. The accountNumber on the suspense payment is set to null. The policy replaces the account as the target.