List recurring payments.

GET

/v1/recurring-payments

curl --request GET \
  --url 'https://api.ridleypay.com/v1/recurring-payments?filter%5Bstatus%5D=active&filter%5Bfrequency%5D=monthly&filter%5Bcustomer_email%5D=jane%40example.com&sort=-created_at&page%5Bsize%5D=25&page%5Bnumber%5D=1' \
  --header 'Authorization: Bearer <token>'

Returns a paginated list of recurring payment schedules for the authenticated source.

Authorizations

• default

Parameters

Query Parameters

filter[status]

Filter by status (active, paused, cancelled, suspended, completed).

string

Filter by status (active, paused, cancelled, suspended, completed).

Example

active

filter[frequency]

Filter by billing frequency.

string

Filter by billing frequency.

Example

monthly

filter[customer_email]

Filter by customer email.

string

Filter by customer email.

Example

jane@example.com

sort

Sort by field. Prefix with - for descending. Allowed: created_at, amount, next_billing_date, status.

string

Sort by field. Prefix with - for descending. Allowed: created_at, amount, next_billing_date, status.

Example

-created_at

page[size]

Number of results per page (max 100).

integer

Number of results per page (max 100).

Example

25

page[number]

Page number.

integer

Page number.

Example

1

Responses

200

Recurring payments list

Media typeapplication/json

object

data

Array<object>

object

id

string

type

string

attributes

object

reference

string

amount

string

currency

string

frequency

string

status

string

next_billing_date

string

links

object

first

string

meta

object

current_page

integer

last_page

integer

per_page

integer

total

integer

Example

{
  "data": [
    {
      "id": "1",
      "type": "recurring-payments",
      "attributes": {
        "reference": "WOO-SUB-456",
        "amount": "29.99",
        "currency": "JMD",
        "frequency": "monthly",
        "status": "active",
        "next_billing_date": "2026-05-01"
      }
    }
  ],
  "links": {
    "first": "https://pay.example.com/api/v1/recurring-payments?page%5Bnumber%5D=1"
  },
  "meta": {
    "current_page": 1,
    "last_page": 1,
    "per_page": 25,
    "total": 1
  }
}