SOsolana
Payments

List recurring payment collection attempts

Changed on

Lists every collection attempt a recurring payment has made over its whole history, newest first: its current subscription and every subscription an edit replaced. A recurring payment that has not been activated has none.

get/v1/payments/recurring-payments/{id}/collection-attempts

Request

  • Base URL
    http://localhost:8787
  • Auth
    HTTP bearer

Path parameters

idstring required

SDP recurring payment record ID.

Example:prp_example

Query parameters

status'pending' | 'processing' | 'confirmed' | 'failed' | 'skipped'

Collection attempt status.

Example:pending
pageinteger
pageSizeinteger

Headers

x-project-idstring

Required for dashboard sessions. API keys use their assigned project.

Example:prj_example

Response

Collection attempt list

Example response

{
  "data": {
    "collectionAttempts": [
      {
        "id": "psca_example",
        "organizationId": "org_example",
        "projectId": "prj_example",
        "transferId": "xfr_example",
        "amount": "100.00",
        "dueAt": "2025-01-01T00:00:00.000Z",
        "attemptedAt": "2025-01-01T00:00:00.000Z",
        "status": "pending",
        "createdAt": "2025-01-01T00:00:00.000Z",
        "updatedAt": "2025-01-01T00:00:00.000Z"
      }
    ]
  },
  "meta": {
    "requestId": "req_example",
    "timestamp": "2025-01-01T00:00:00.000Z"
  }
}

Changes