Reactivate Payment Plan

PATCH/rest/payment_plans/:id/reactivate

Production URL

https://api.betterpayment.de/rest/payment_plans/:id/reactivate

Test URL

https://testapi.betterpayment.de/rest/payment_plans/:id/reactivate

Reactivate a canceled payment plan. Only payment plans with canceled status can be reactivated. When a payment plan is reactivated, all canceled installment transactions are set back to scheduled status. If a payment plan has any past scheduled transactions, you can not reactivate a payment plan. Please, contact us for adjustments of the scheduled dates for reactivation.

Request

idIntegerrequired

Payment plan ID in the URL path

Example Request

PATCH /rest/payment_plans/123/reactivate
Authorization: Basic <base64(api_key:api_password)>

Response

On success, returns the updated payment plan object with status changed to active.

errorString

Error details (null on success)

messageString

Success or error message

payment_planObject

Updated payment plan object with status set to active

Example Response (200)

{
"error": null,
"message": "Payment plan has been successfully reactivated.",
"payment_plan": {
  "id": 123,
  "status": "active",
  "plan_type": "six_months",
  "installments": 6
}
}

Error response (422)

errorString

Error details

messageString

Error message describing why the plan cannot be reactivated

Example Response (422)

{
"error": "Cannot reactivate payment plan",
"message": "Only canceled payment plans can be reactivated. Current status: active"
}