FAfatzebra

Cancel a payment plan

Changed on

Payment Plans can be cancelled which removed any scheduled payments and stops the plan from being processed. Once a Plan has been cancelled it is considered 'Deleted' and cannot be re-activated.

delete/payment_plans/{id_or_reference}

Request

  • Base URL
    https://gateway.pmnts-sandbox.io/v1.0
  • URL
    https://gateway.pmnts-sandbox.io/v1.0/payment_plans/{id_or_reference}
  • Auth
    HTTP basic

Path parameters

id_or_referencestring required

ID or reference of the payment plan to cancel.

Response

200

successfulboolean
testboolean

Example response

{
  "successful": true,
  "response": {
    "id": "071-PP-8389G3DA",
    "customer": "071-C-JE34F66V",
    "amount": 100,
    "frequency": "Weekly",
    "anniversary": 5,
    "start_date": "2025-07-16",
    "total_count": 2,
    "payment_method": "Credit Card",
    "reference": "071-PP-8389G3DA",
    "status": "Cancelled",
    "status_reason": "Other",
    "created_at": "2018-07-11T16:23:39+10:00",
    "retry_interval": 3
  },
  "test": true
}

Changes