Update a recurring payment schedule.

PATCH

/v1/recurring-payments/{reference}

const url = 'https://api.ridleypay.com/v1/recurring-payments/WOO-SUB-456';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"amount":39.99,"frequency":"daily","interval_count":1,"next_billing_date":"2026-05-01","end_date":"2027-04-06","customer_email":"new@example.com","customer_name":"Jane Smith","metadata":{"plan":"premium"},"apply_tax":true}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request PATCH \
  --url https://api.ridleypay.com/v1/recurring-payments/WOO-SUB-456 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "amount": 39.99, "frequency": "daily", "interval_count": 1, "next_billing_date": "2026-05-01", "end_date": "2027-04-06", "customer_email": "new@example.com", "customer_name": "Jane Smith", "metadata": { "plan": "premium" }, "apply_tax": true }'

Updates the amount, frequency, billing dates, or customer info of a recurring payment.

Authorizations

default

Parameters

Path Parameters

reference

required

string

The recurring payment reference.

Example

WOO-SUB-456

Request Body

application/json

object

amount

Updated charge amount. Must be at least 0.01.

number

Example

39.99

frequency

Updated billing frequency: daily, weekly, monthly, or yearly.

string

Allowed values: daily weekly monthly yearly

Example

monthly

interval_count

Updated interval between charges. Must be at least 1. Must not be greater than 365.

integer

Example

next_billing_date

Override the next billing date. Must be a valid date. Must be a date after or equal to today.

string

Example

2026-05-01

end_date

Updated end date. Null to remove. Must be a valid date. Must be a date after today.

string

nullable

Example

2027-04-06

customer_email

Updated customer email. Must be a valid email address. Must not be greater than 255 characters.

string

nullable

Example

new@example.com

customer_name

Updated customer name. Must not be greater than 255 characters.

string

nullable

Example

Jane Smith

metadata

Updated metadata. Replaces existing metadata entirely.

object

Example

{
  "plan": "premium"
}

apply_tax

Apply your team tax settings to future charges.

boolean

Example

true

Responses

200

Updated

application/json

object

data

object

string

type

string

attributes

object

reference

string

amount

string

frequency

string

status

string

next_billing_date

string

links

object

self

string

meta

object

message

string

Example

{
  "data": {
    "id": "1",
    "type": "recurring-payments",
    "attributes": {
      "reference": "WOO-SUB-456",
      "amount": "39.99",
      "frequency": "monthly",
      "status": "active",
      "next_billing_date": "2026-05-01"
    },
    "links": {
      "self": "https://pay.example.com/api/v1/recurring-payments/WOO-SUB-456"
    }
  },
  "meta": {
    "message": "Recurring payment updated."
  }
}

404

Not found

application/json

object

errors

Array<object>

object

status

string

title

string

detail

string

Example

{
  "errors": [
    {
      "status": "404",
      "title": "Not Found",
      "detail": "Recurring payment not found."
    }
  ]
}

422

Cannot update

application/json

object

errors

Array<object>

object

status

string

title

string

detail

string

Example

{
  "errors": [
    {
      "status": "422",
      "title": "Unprocessable Entity",
      "detail": "Cannot update a cancelled or completed recurring payment."
    }
  ]
}