POST Api/PaymentPlan

Revise an existing payment plan in the system.

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
CustomerToken	Contains the unique customer token used to identify the customer the payment plan is being added/edited for.	string	Required
DateToStart	Date to start the payment plan.	date-time?	None.
DayToPay	Specifies the day of month to fire the payment plan.	int	Required
DayType	Specifies whether the payment plan fires against the due date on the current bill, or the specified day of the month.	PaymentPlanDayType	Required
FeeWaived	Specifies whether this payment plan has fee waived.	boolean	None.
MonthlyAmount	(Obsolete) Specifies the amount to pay each month.	decimal	None.
OriginalPlanID		int?	None.
OtherData	For payment plans associated with a single billing account, contains the Other Data of the selected billing account.	string	String length: inclusive between 0 and 100
PaymentAccount	For enrolled or one-time payments, contains the new payment account information to use for the payment. Will be saved as an available payment account for enrolled customers.	PaymentAccountModel	None.
PaymentAccountToken	For enrolled payments, contains the payment account token of the existing payment account to use.	string	String length: inclusive between 0 and 2048
PaymentAmount	Specifies the amount to pay every time the payment plan fires.	decimal	None.
PaymentName	Specifies the name to give this payment plan.	string	Required
PaymentPlanID	Contains the ID of the payment plan being modified	int	Required
Payments	Optionally specifies the customized payment amounts that will pay off this payment plan.	Collection of PaymentPlanPaymentModel	None.
PPD	Specifies if this payment plan is a PPD payment.	boolean	None.
ReferenceNumber	For payment plans associated with a single billing account, contains the Reference Number of the selected billing account	string	String length: inclusive between 0 and 100
SelectedAccounts	For payment plans created against master-entity accounts, optionally restricts the billing accounts in the master-entity that the payment plan will fire against.	Collection of long	None.

Request Formats

application/json, text/json

Sample:

{
  "PaymentPlanID": 1,
  "CustomerToken": "sample string 2",
  "DateToStart": "2025-05-21T06:35:32.8127145Z",
  "DayToPay": 3,
  "DayType": "DayToPay",
  "FeeWaived": true,
  "MonthlyAmount": 5.0,
  "OriginalPlanID": 1,
  "PaymentAccount": {
    "AchAccountNumber": "sample string 1",
    "AchInstitutionNumber": "sample string 2",
    "AchRememberMe": true,
    "AchRoutingNumber": "sample string 3",
    "AchRegion": "USA",
    "AchTransitNumber": "sample string 4",
    "AchType": "Unknown",
    "AchUsageType": "Unknown",
    "AchValidate": true,
    "Address": "sample string 6",
    "Address2": "sample string 7",
    "Agree": true,
    "CcAccountNumber": "sample string 15",
    "CcCardType": "Unknown",
    "CcCVV": "sample string 16",
    "CcExpirationDate": "sample string 17",
    "CcRememberMe": true,
    "City": "sample string 19",
    "Country": "sample string 20",
    "Description": "sample string 21",
    "EnrollInRTP": true,
    "IsPinacleAccount": true,
    "IsRTP": true,
    "IsWalkIn": true,
    "Name": "sample string 25",
    "NotifyBillsToPinacle": true,
    "SingleUse": true,
    "SkipAccountOwnerCheck": true,
    "SkipCardPreauth": true,
    "State": "sample string 30",
    "Token": "sample string 31",
    "Zip": "sample string 32",
    "TerminalID": "sample string 36",
    "AccountType": "ACH"
  },
  "PaymentAccountToken": "sample string 6",
  "PaymentAmount": 7.0,
  "PaymentName": "sample string 8",
  "Payments": [
    {
      "Amount": 1.0,
      "PaymentDate": "2025-05-21T06:35:32.8283271Z"
    },
    {
      "Amount": 1.0,
      "PaymentDate": "2025-05-21T06:35:32.8283271Z"
    }
  ],
  "PPD": true,
  "ReferenceNumber": "sample string 10",
  "OtherData": "sample string 11",
  "SelectedAccounts": [
    1,
    2
  ]
}

Response Information

Resource Description

Revise an existing payment plan in 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.8595763Z",
        "ExistingPaymentPlanID": 1,
        "PendingPayment": {
          "AccountTotal": 1.0,
          "CreateDate": "2025-05-21T06:35:32.8595763Z",
          "Status": "Initiated",
          "Total": 3.0,
          "TransactionID": 4
        },
        "PendingPayments": [
          {
            "AccountTotal": 1.0,
            "CreateDate": "2025-05-21T06:35:32.8595763Z",
            "Status": "Initiated",
            "Total": 3.0,
            "TransactionID": 4
          },
          {
            "AccountTotal": 1.0,
            "CreateDate": "2025-05-21T06:35:32.8595763Z",
            "Status": "Initiated",
            "Total": 3.0,
            "TransactionID": 4
          }
        ],
        "RoleMaskedAccount": "sample string 5",
        "Stopped": true,
        "UpdateDate": "2025-05-21T06:35:32.8595763Z"
      },
      {
        "AccountID": 1,
        "AccountNumber": "sample string 2",
        "AmountDue": 3.0,
        "CurrencySymbol": "sample string 4",
        "DueDate": "2025-05-21T06:35:32.8595763Z",
        "ExistingPaymentPlanID": 1,
        "PendingPayment": {
          "AccountTotal": 1.0,
          "CreateDate": "2025-05-21T06:35:32.8595763Z",
          "Status": "Initiated",
          "Total": 3.0,
          "TransactionID": 4
        },
        "PendingPayments": [
          {
            "AccountTotal": 1.0,
            "CreateDate": "2025-05-21T06:35:32.8595763Z",
            "Status": "Initiated",
            "Total": 3.0,
            "TransactionID": 4
          },
          {
            "AccountTotal": 1.0,
            "CreateDate": "2025-05-21T06:35:32.8595763Z",
            "Status": "Initiated",
            "Total": 3.0,
            "TransactionID": 4
          }
        ],
        "RoleMaskedAccount": "sample string 5",
        "Stopped": true,
        "UpdateDate": "2025-05-21T06:35:32.8595763Z"
      }
    ],
    "CanEdit": true,
    "CurrencySymbol": "sample string 2",
    "CustomerID": 1,
    "CreateDate": "2025-05-21T06:35:32.8595763Z",
    "DayToPay": 4,
    "DayType": "DayToPay",
    "DisplayDescription": "sample string 5",
    "InitialBalance": 6.0,
    "LastEvaluatedDate": "2025-05-21T06:35:32.8595763Z",
    "LastPaymentAmount": 7.0,
    "LastPaymentDate": "2025-05-21T06:35:32.8595763Z",
    "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.8752166Z",
        "PaymentID": 1
      },
      {
        "Amount": 1.0,
        "PaymentDate": "2025-05-21T06:35:32.8752166Z",
        "PaymentID": 1
      }
    ],
    "RemainingBalance": 14.0,
    "PaymentCount": 15,
    "PaymentPlanType": "Fixed",
    "PPD": true,
    "StartDate": "2025-05-21T06:35:32.8752166Z",
    "Status": "Active",
    "Term": 18,
    "UpdateDate": "2025-05-21T06:35:32.8752166Z"
  },
  "Success": true
}