DELETE Api/PaymentPlan?customerToken={customerToken}&paymentPlanID={paymentPlanID}

Deletes an existing payment plan from the system.

Request Information

URI Parameters

Name	Description	Type	Additional information
customerToken	Contains the unique customer token used to identify the customer the payment plan is being deleted from.	string	None.
paymentPlanID	Contains the ID of the payment plan to cancel.	int?	None.

Body Parameters

None.

Response Information

Resource Description

Deletes an existing payment plan from the system.

APIPaymentPlanResponseModel

Name	Description	Type	Additional information
ErrorCode	Name of the error condition. See ErrorCode model for details.	ErrorCode	None.
ErrorID	Internal error identification number that uniquely identifies this specific error that occurred.	string	None.
ErrorNum	Numeric value of the ErrorCode	int	None.
Errors	List of errors that occurred when performing the payment plan request.	Collection of string	None.
Result		PaymentPlanResponseModel	None.
Success	Indicates sucess or failure of the REST request.	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "ErrorCode": "None",
  "ErrorID": "sample string 1",
  "ErrorNum": 0,
  "Errors": [
    "sample string 1",
    "sample string 2"
  ],
  "Result": {
    "BillingAccounts": [
      {
        "AccountID": 1,
        "AccountNumber": "sample string 2",
        "AmountDue": 3.0,
        "CurrencySymbol": "sample string 4",
        "DueDate": "2025-05-21T06:35:32.7345777Z",
        "ExistingPaymentPlanID": 1,
        "PendingPayment": {
          "AccountTotal": 1.0,
          "CreateDate": "2025-05-21T06:35:32.7345777Z",
          "Status": "Initiated",
          "Total": 3.0,
          "TransactionID": 4
        },
        "PendingPayments": [
          {
            "AccountTotal": 1.0,
            "CreateDate": "2025-05-21T06:35:32.7345777Z",
            "Status": "Initiated",
            "Total": 3.0,
            "TransactionID": 4
          },
          {
            "AccountTotal": 1.0,
            "CreateDate": "2025-05-21T06:35:32.7345777Z",
            "Status": "Initiated",
            "Total": 3.0,
            "TransactionID": 4
          }
        ],
        "RoleMaskedAccount": "sample string 5",
        "Stopped": true,
        "UpdateDate": "2025-05-21T06:35:32.7345777Z"
      },
      {
        "AccountID": 1,
        "AccountNumber": "sample string 2",
        "AmountDue": 3.0,
        "CurrencySymbol": "sample string 4",
        "DueDate": "2025-05-21T06:35:32.7345777Z",
        "ExistingPaymentPlanID": 1,
        "PendingPayment": {
          "AccountTotal": 1.0,
          "CreateDate": "2025-05-21T06:35:32.7345777Z",
          "Status": "Initiated",
          "Total": 3.0,
          "TransactionID": 4
        },
        "PendingPayments": [
          {
            "AccountTotal": 1.0,
            "CreateDate": "2025-05-21T06:35:32.7345777Z",
            "Status": "Initiated",
            "Total": 3.0,
            "TransactionID": 4
          },
          {
            "AccountTotal": 1.0,
            "CreateDate": "2025-05-21T06:35:32.7345777Z",
            "Status": "Initiated",
            "Total": 3.0,
            "TransactionID": 4
          }
        ],
        "RoleMaskedAccount": "sample string 5",
        "Stopped": true,
        "UpdateDate": "2025-05-21T06:35:32.7345777Z"
      }
    ],
    "CanEdit": true,
    "CurrencySymbol": "sample string 2",
    "CustomerID": 1,
    "CreateDate": "2025-05-21T06:35:32.7345777Z",
    "DayToPay": 4,
    "DayType": "DayToPay",
    "DisplayDescription": "sample string 5",
    "InitialBalance": 6.0,
    "LastEvaluatedDate": "2025-05-21T06:35:32.7345777Z",
    "LastPaymentAmount": 7.0,
    "LastPaymentDate": "2025-05-21T06:35:32.7345777Z",
    "MonthlyAmount": 9.0,
    "PaymentAccountID": 10,
    "PaymentAccount": {
      "Account": "Visa",
      "AccountNumberLastFour": "1234",
      "AchBankName": "sample string 1",
      "AchRegion": "USA",
      "Address": "sample string 2",
      "Address2": "sample string 3",
      "CcCardType": "Visa",
      "CcChargeType": "Unknown",
      "CcExpirationDate": "01/16",
      "City": "sample string 5",
      "Country": "USA",
      "Description": "sample string 7",
      "DisplayAccountNumber": "*****1234",
      "DisplayDescription": "sample string 8",
      "DisplayRoutingNumber": "*****0614",
      "ExternalUserID": "sample string 10",
      "FirstName": "sample string 11",
      "IsAmazonPay": true,
      "IsApplePay": true,
      "IsBankAccount": true,
      "IsBilledByAutoDebit": true,
      "IsBilledByPaymentPlan": true,
      "IsBilledByRecurringPayment": true,
      "IsBlocked": true,
      "IsBusinessAccount": true,
      "IsCheckingAccount": true,
      "IsCreditCard": true,
      "IsPayPal": true,
      "IsPersonalAccount": true,
      "IsPinacleAccount": true,
      "IsRTPAccount": true,
      "IsRTPEligible": true,
      "IsSavingsAccount": true,
      "LastName": "sample string 29",
      "Name": "sample string 30",
      "PaymentAccountType": "ACH",
      "State": "NY",
      "Swiped": true,
      "Token": "sample string 34",
      "Validated": true,
      "Zip": "sample string 35"
    },
    "PaymentAmount": 11.0,
    "PaymentName": "sample string 12",
    "PaymentPlanID": 13,
    "Payments": [
      {
        "Amount": 1.0,
        "PaymentDate": "2025-05-21T06:35:32.7502133Z",
        "PaymentID": 1
      },
      {
        "Amount": 1.0,
        "PaymentDate": "2025-05-21T06:35:32.7502133Z",
        "PaymentID": 1
      }
    ],
    "RemainingBalance": 14.0,
    "PaymentCount": 15,
    "PaymentPlanType": "Fixed",
    "PPD": true,
    "StartDate": "2025-05-21T06:35:32.7502133Z",
    "Status": "Active",
    "Term": 18,
    "UpdateDate": "2025-05-21T06:35:32.7502133Z"
  },
  "Success": true
}