latestOpenAPI 3.0.32026-08-20146131.7 MB

672b1916ba61

Payments

List subscription collection attempts

Lists collection attempts for a recurring-payment subscription.

get/v1/payments/subscriptions/{subscriptionId}/collection-attempts

Path parameters

subscriptionIdstring required

SDP subscription record ID.

Example:psub_example

SDP subscription record ID.

Query parameters

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

Collection attempt status.

Example:pending

Collection attempt status.

pageinteger

pageSizeinteger

Headers

x-project-idstring

Selects the active project for this request. Required for session/dashboard callers. Ignored when authenticating with an API key, whose scope is fixed to the key's project.

Example:prj_example

Selects the active project for this request. Required for session/dashboard callers. Ignored when authenticating with an API key, whose scope is fixed to the key's project.

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"
  }
}