Update a payment plan

put

https://gateway.pmnts-sandbox.io/v1.0/payment_plans/{id_or_reference}

A Payment Plan's status can only be updated to Cancelled, Suspended or Active. For a suspended plan it is possible to set a date the plan is suspended until.

When a plan is suspended, any pending payments will be removed. If the plan is resumed, the pending payments will be re-created to meet the plan's constraints.

Note: Payment plan must be active for any other attributes to be updated.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

id_or_reference

string

required

ID or merchant's reference of the payment plan to update.

Body Params

card_token

string

The card token to link this payment plan to

new_status

string

Status to update to. Valid values are "Suspended", "Active", "Cancelled",

reason

string

Reason for updating payment plan status

until_date

date

Optionally used when suspending or activating a plan. This date will be saved on the payment plan for record-keeping purposes. The plan will need to be manually actioned on this date.

amount

int32

Recurring payment amount in the smallest unit of the currency.

setup_fee

int32

Setup fee to be charged upon creation of the payment plan.

frequency

string

Frequency of the payments. Acceptable values are: Daily, Weekly, Fortnightly, Monthly, 4 Weekly, Quarterly, Half Yearly, Annually.

payment_method

string

Payment method for the plan - this can be Credit Card or Direct Debit. Note that if the customer is not setup with the defined payment method an error will be returned.

anniversary

string

Anniversary of the recurring payments. For Weekly and Fortnightly payments this will be the day of the week (1 - Monday, 2 - Tuesday, 3 - Wednesday, 4 - Thursday, 5 - Friday) For Monthly this will be the day of the month. If the day of the month is greater then 28, and the month is shorter then the anniversary this date will be moved forward to the nearest possible date (i.e. a payment for the 31st will fall on the 30th for monthly like September etc).

start_date

date

Date that the payment plan should start. This must be in the future.

end_date

date

Date that the payment plan should end on. This must be in the future and greater than the start_date.

reference

string

Reference for the payment plan.

description

string

Description for the payment plan (e.g. Model 200R Blender Lay-by).

currency

string

ISO 4217 currency code for the plan.

total_count

int32

Total number of payments to process for this plan.

total_amount

int32

Total amount of all payments to be processed for this plan.

failed_payment_fee

int32

Defaults to 0

Fee that applies to the retried payment in the event of any declined payment. Note: This amount will compound for the total number of retries (3) performed.

retry_interval

int32

Defaults to 3

Number of days between payment retries for any declined payments.

Responses

200200

404404