Update Recurring Payment

put

https://api.paysimple.com/v4/recurringpayment

Modifies the specified recurring payment.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

🚧
NOTE
You must include all properties that were included in creating in the recurring payment in the update request, regardless if they are modified or not.

Body Params

int32

required

The ScheduleId of the Recurring Payment to be modified.

PaymentAmount

double

required

Amount of the payment to be charged on the scheduled time.

AccountId

int32

required

Id for the Credit Card Account or ACH Account used for the schedule. Any AccountId associated with the Customer is valid. If account associated changes the payment method of the schedule Credit Card to ACH, or vice versa, and do not specify a new PaymentSubType the system will update the schedule with the default sub-type for the account type (Moto for CC and ACH Web for ACH).

StartDate

date

required

The date the schedule is configured to start running. If this date is in the future you can change it to the current date or any other future date. If this date has passed, then this field is read-only and cannot be changed. Date format: YYYY-MM-DD.

ExecutionFrequencyType

string

required

Frequency to run the schedule. Valid values: Daily, Weekly, BiWeekly, FirstofMonth, SpecificDayofMonth, LastofMonth, Quarterly, SemiAnnually, Annually

ExecutionFrequencyParameter

int32

Required if ExecutionFrequencyType is Weekly or SpecificDayofMonth. If Weekly specifies day of week (1=Sunday; 2=Monday; 3=Tuesday; 4=Wednesday; 5=Thursday). If SpecificDayofMonth, refers to day of month. If day of the month does not exist for a given month (e.g. 30 in February), the schedule will fire on the last day of the month. However, LastofMonth is suggested for this use case to avoid confusion.

EndDate

date

The date the schedule is to stop generating payments. You can change this date to any other future date, or set it to “null” to run the schedule indefinitely. Date format: YYYY-MM-DD.

InvoiceNumber

string

The Invoice Number attached to the schedule. 50 characters max.

Description

string

2048 characters max.

FirstPaymentAmount

double

Custom payment amount that is executed prior to the start of the schedule. You can only change this amount if the FirstPaymentDate is in the future. Once the payment has been generated this field becomes read-only.

FirstPaymentDate

date

Date the custom first payment is to be processed. You can only change this if the existing date is in the future, and you can change it to the current date or any other future date. Once the payment has been generated this field becomes read-only. Date format: YYYY-MM-DD.

PaymentSubType

string

Defaults to Moto for credit card payments and Web for ACH payments if not included or left null. You can manually enter a new value for this field or omit it (or set it to null) and let the system assign the default sub-type for the AccountId.

Responses

NOTE

200200

400400