v1

latestOpenAPI 3.1.02026-07-2414085.2 KB

Create a payment plan

post/payment_plans

Request body

customerstring required

ID of the customer that the plan should belong to.

card_tokenstring

The token for a card to link this payment plan to

amountinteger required

Recurring payment amount in the smallest unit of the currency.

setup_feeinteger

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

frequencystring required

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

payment_methodstring required

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.

anniversaryinteger required

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_datestring date required

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

end_datestring date

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

referencestring

Reference for the payment plan.

descriptionstring

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

currencystring

ISO 4217 currency code for the plan.

total_countinteger

Total number of payments to process for this plan.

total_amountinteger

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

failed_payment_feeinteger

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_intervalinteger

Number of days between payment retries for any declined payments.

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": "Active",
    "status_reason": "None",
    "created_at": "2018-07-11T16:23:39+10:00",
    "retry_interval": 3,
    "card_token": "ABC12345",
    "payments": [
      {
        "id": "071-PT-WQ8LIHI4",
        "payment_plan": "071-PP-8389G3DA",
        "reference": "071-PP-8389G3DA-0001",
        "amount": 100,
        "scheduled_date": "2025-07-18",
        "payment_method": "Credit Card",
        "status": "Scheduled"
      }
    ]
  },
  "test": true
}