# List recurring payments

Retrieve a paginated list of recurring payment configurations for the location.

Endpoint: GET /partner/v2/account/{accountId}/location/{locationId}/recurring-payment
Version: 2.0
Security: PartnerOAuth

## Query parameters:

  - `patientId` (integer)
    Filter by patient ID

  - `status` (string)
    Filter by status
    Enum: "ACTIVE", "PAUSED", "CANCELLED", "COMPLETED", "FAILED"

  - `cursor` (string)
    Pagination cursor from previous response

  - `limit` (integer)
    Number of results per page (max 100)
    Example: 20

## Path parameters:

  - `accountId` (integer, required)
    Account identifier

  - `locationId` (integer, required)
    Location identifier

## Response 200 fields (application/json):

  - `nextCursor` (string)
    Opaque cursor for fetching the next page. Null if no more results.

  - `recurringPayments` (array)
    List of recurring payments

  - `recurringPayments.amountCents` (integer)
    Amount per payment in cents
    Example: 10000

  - `recurringPayments.amountDisplay` (string)
    Formatted amount
    Example: "$100.00"

  - `recurringPayments.cardBrand` (string)
    Card brand
    Example: "visa"

  - `recurringPayments.cardLast4` (string)
    Last 4 digits of card on file
    Example: "4242"

  - `recurringPayments.completedPayments` (integer)
    Number of payments completed
    Example: 3

  - `recurringPayments.createdAt` (string)
    Creation timestamp
    Example: "2025-01-01T10:00:00Z"

  - `recurringPayments.description` (string)
    Description/memo
    Example: "Monthly payment plan"

  - `recurringPayments.endDate` (string)
    When the recurring payment ends (if limited)
    Example: "2025-12-31T23:59:59Z"

  - `recurringPayments.frequency` (string)
    Payment frequency
    Enum: "WEEKLY", "BIWEEKLY", "MONTHLY", "QUARTERLY", "ANNUALLY"

  - `recurringPayments.id` (integer)
    Unique recurring payment identifier
    Example: 12345

  - `recurringPayments.nextPaymentDate` (string)
    Date of next payment
    Example: "2025-02-01"

  - `recurringPayments.patientId` (integer)
    Patient ID
    Example: 67890

  - `recurringPayments.patientName` (string)
    Patient name
    Example: "John Doe"

  - `recurringPayments.remainingPayments` (integer)
    Number of payments remaining
    Example: 9

  - `recurringPayments.startDate` (string)
    When the recurring payment started
    Example: "2025-01-01T00:00:00Z"

  - `recurringPayments.status` (string)
    Status
    Enum: "ACTIVE", "PAUSED", "CANCELLED", "COMPLETED", "FAILED"

  - `recurringPayments.totalPayments` (integer)
    Total number of payments (null = unlimited)
    Example: 12

  - `recurringPayments.updatedAt` (string)
    Last update timestamp
    Example: "2025-01-10T14:30:00Z"


## Response 400 fields

## Response 401 fields

## Response 403 fields