---
title: "Retrieve all recurring payments created by an API client"
method: GET
path: "/recurring-payments"
tags: ["payments"]
---

# Retrieve all recurring payments created by an API client

`GET /recurring-payments`

Requires **recurring-payment:read** scope.

## Query parameters

- `limit` integer
- `offset` integer
- `userId` string

## Response `200`

Successful Recurring Payment Response

- object
  - `data` RecurringPaymentRequest[]
    - `id` string, uuid, required — The id of the recurring payment
    - `status` 'InProgress' | 'AwaitingAuthorisation' | 'Rejected' | 'Authorised' | 'Expired'
    - `createdAt` string, date-time, required — The date that the recurring payment was created
    - `updatedAt` string, date-time — The date that the recurring payment was last updated
    - `revokedAt` string, date-time, nullable — The date that the recurring payment was revoked
    - `recurringPayment` object, required
      - `reference` string — The name or description given to the recurring payment
      - `validFromDate` string, date-time — The date from which the authorisation is effective
      - `validToDate` string, date-time — The date to which the authorisation is effective
      - `maximumIndividualAmount` integer — The maximum single payment amount in minor units of the currency, eg. pennies for GBP.
      - `currency` string — The currency of the maximum payment amount
      - `periodicLimits` object[]
        - `amount` number — The maximum amount for this recurring payment limit
        - `currency` string — The currency code for this recurring payment limit
        - `periodType` 'Day' | 'Week' | 'Fortnight' | 'Month' | 'Half-year' | 'Year' — The currency code for this recurring payment limit
        - `periodAlignment` 'Consent' | 'Calendar' — The currency code for this recurring payment limit
      - `type` string[] — Specifies the type of payments to be made
  - `meta` Meta
    - `limit` integer
    - `offset` integer
    - `total` integer

## Other responses

- `401` — Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token
- `403` — Unsuccessful Response - Forbidden - Invalid scopes

---

[API](https://skmtc.net/moneyhubenterprise/apis/moneyhub-identity-service.md) · [All operations](https://skmtc.net/moneyhubenterprise/apis/moneyhub-identity-service/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/moneyhubenterprise/moneyhub-identity-service/revisions/8841721f7aae/schema)