Skip to main content
GET
/
api
/
recurring-payment
/
list
List Recurring Payments
curl --request GET \
  --url https://app.dimepayments.com/api/recurring-payment/list \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "data": [],
  "filters": []
}
'
{
  "data": [
    {
      "id": 1,
      "name": "Car Was Solutions ",
      "amount": "4,574.99",
      "start_date": "2024-11-07T05:00:00.000000Z",
      "end_date": "2026-12-31T05:00:00.000000Z",
      "recurrence_schedule": "Monthly",
      "last_run_date": "2025-12-15T05:00:00.000000Z",
      "last_run_status": "Failed",
      "last_run_failed_count": 3,
      "next_run_date": null,
      "status": "Failed",
      "paused_until_date": null,
      "customer_uuid": "9a242468-6b4e-4382-a61b-a728fbc8edae",
      "cancelled_at": null,
      "error": "DECLINE",
      "payment_method": {
        "id": 7,
        "type": "cc",
        "last_four": "4003",
        "expiration": "09/2029",
        "zip": "",
        "name_on_card": "Geo Perez"
      },
      "shipping_address": {
        "addr1": null,
        "addr2": null,
        "city": null,
        "state": null,
        "zip": null
      }
    },
    {
      "id": 1,
      "name": "Car Was Solutions ",
      "amount": "4,574.99",
      "start_date": "2024-11-07T05:00:00.000000Z",
      "end_date": "2026-12-31T05:00:00.000000Z",
      "recurrence_schedule": "Monthly",
      "last_run_date": "2025-12-15T05:00:00.000000Z",
      "last_run_status": "Failed",
      "last_run_failed_count": 3,
      "next_run_date": null,
      "status": "Failed",
      "paused_until_date": null,
      "customer_uuid": "9a242468-6b4e-4382-a61b-a728fbc8edae",
      "cancelled_at": null,
      "error": "DECLINE",
      "payment_method": {
        "id": 7,
        "type": "cc",
        "last_four": "4003",
        "expiration": "09/2029",
        "zip": "",
        "name_on_card": "Geo Perez"
      },
      "shipping_address": {
        "addr1": null,
        "addr2": null,
        "city": null,
        "state": null,
        "zip": null
      }
    }
  ],
  "links": {
    "prev": [
      null,
      null
    ],
    "next": [
      null,
      null
    ],
    "first": null,
    "last": null
  },
  "meta": {
    "path": [
      "/",
      "/"
    ],
    "per_page": [
      15,
      15
    ],
    "next_cursor": [
      null,
      null
    ],
    "prev_cursor": [
      null,
      null
    ]
  }
}

Authorizations

Authorization
string
header
required

You can retrieve your token by visiting your dashboard and clicking Generate API token under your profile in top right.

Body

application/json
data
object
Example:
[]
filters
object
Example:
[]

Response

data
object[]
Example:
[
  {
    "id": 1,
    "name": "Car Was Solutions ",
    "amount": "4,574.99",
    "start_date": "2024-11-07T05:00:00.000000Z",
    "end_date": "2026-12-31T05:00:00.000000Z",
    "recurrence_schedule": "Monthly",
    "last_run_date": "2025-12-15T05:00:00.000000Z",
    "last_run_status": "Failed",
    "last_run_failed_count": 3,
    "next_run_date": null,
    "status": "Failed",
    "paused_until_date": null,
    "customer_uuid": "9a242468-6b4e-4382-a61b-a728fbc8edae",
    "cancelled_at": null,
    "error": "DECLINE",
    "payment_method": {
      "id": 7,
      "type": "cc",
      "last_four": "4003",
      "expiration": "09/2029",
      "zip": "",
      "name_on_card": "Geo Perez"
    },
    "shipping_address": {
      "addr1": null,
      "addr2": null,
      "city": null,
      "state": null,
      "zip": null
    }
  },
  {
    "id": 1,
    "name": "Car Was Solutions ",
    "amount": "4,574.99",
    "start_date": "2024-11-07T05:00:00.000000Z",
    "end_date": "2026-12-31T05:00:00.000000Z",
    "recurrence_schedule": "Monthly",
    "last_run_date": "2025-12-15T05:00:00.000000Z",
    "last_run_status": "Failed",
    "last_run_failed_count": 3,
    "next_run_date": null,
    "status": "Failed",
    "paused_until_date": null,
    "customer_uuid": "9a242468-6b4e-4382-a61b-a728fbc8edae",
    "cancelled_at": null,
    "error": "DECLINE",
    "payment_method": {
      "id": 7,
      "type": "cc",
      "last_four": "4003",
      "expiration": "09/2029",
      "zip": "",
      "name_on_card": "Geo Perez"
    },
    "shipping_address": {
      "addr1": null,
      "addr2": null,
      "city": null,
      "state": null,
      "zip": null
    }
  }
]
meta
object