> ## Documentation Index
> Fetch the complete documentation index at: https://docs.rcur.app/llms.txt
> Use this file to discover all available pages before exploring further.

# List payment links



## OpenAPI

````yaml /openAPI.json get /api/v2/links
openapi: 3.0.2
info:
  title: Laravel
  version: 2.0.0
servers:
  - url: https://rcur.app
security:
  - '': []
tags:
  - name: Customers
  - name: Payment Links
  - name: Subscriptions
  - name: Follow-ups
  - name: Orders
  - name: Payments
  - name: Mandates
  - name: Products
  - name: Organization
paths:
  /api/v2/links:
    get:
      tags:
        - Payment Links
      summary: List payment links
      parameters:
        - name: page
          in: query
          description: Page number for pagination
          required: false
          schema:
            default: 1
            type: integer
      responses:
        '200':
          description: List of payment links
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Link'
                  links:
                    type: object
                    properties:
                      first:
                        type: string
                        example: https://rcur.app/api/v2/links?page=1
                      last:
                        type: string
                        example: https://rcur.app/api/v2/links?page=2
                      prev:
                        type: string
                        nullable: true
                      next:
                        type: string
                        nullable: true
                        example: https://rcur.app/api/v2/links?page=2
                  meta:
                    type: object
                    properties:
                      current_page:
                        type: integer
                        example: 1
                      from:
                        type: integer
                        example: 1
                      last_page:
                        type: integer
                        example: 2
                      path:
                        type: string
                        example: https://rcur.app/api/v2/links
                      per_page:
                        type: integer
                        example: 15
                      to:
                        type: integer
                        example: 15
                      total:
                        type: integer
                        example: 23
components:
  schemas:
    Link:
      type: object
      required:
        - id
        - status
        - active
        - type
        - description
        - currency
        - created_at
        - url
      properties:
        id:
          type: string
          example: lnk_abc123
        status:
          enum:
            - draft
            - open
            - paid
            - expired
          type: string
          example: open
        active:
          type: boolean
          example: true
        type:
          enum:
            - payment
            - approval
            - basic-subscription
            - advanced-subscription
            - order
            - mandate
            - debit
          type: string
          example: payment
        description:
          type: string
          example: Monthly subscription - Pro plan
        currency:
          enum:
            - EUR
          type: string
          example: EUR
        amount:
          type: string
          example: '29.95'
        first_amount:
          type: string
          nullable: true
          example: '14.95'
        interval:
          enum:
            - week
            - month
            - quarter
            - year
          type: string
          nullable: true
          example: month
        times:
          type: integer
          nullable: true
          example: 12
        trial_interval:
          type: string
          nullable: true
          example: 14 days
        reminder_at:
          type: string
          nullable: true
          example: '2025-02-01 09:00:00'
        redirect_url_paid:
          type: string
          nullable: true
          example: https://example.com/thank-you
        redirect_url_failed:
          type: string
          nullable: true
          example: https://example.com/failed
        expires_at:
          type: string
          nullable: true
          example: '2025-06-01'
        created_at:
          type: string
          example: '2025-01-15 10:30:00'
        url:
          type: string
          example: https://rcur.nl/pay/lnk_abc123
        customer:
          $ref: '#/components/schemas/Customer'
        subscription:
          $ref: '#/components/schemas/Subscription'
    Customer:
      type: object
      required:
        - id
        - first_name
        - last_name
        - email
        - created_at
      properties:
        id:
          type: string
          example: abc123def456
        number:
          type: string
          nullable: true
          example: CUST-001
        first_name:
          type: string
          example: John
        last_name:
          type: string
          example: Doe
        email:
          type: string
          example: john@example.com
        phone:
          type: string
          nullable: true
          example: '+31612345678'
        organization_name:
          type: string
          nullable: true
          example: Acme B.V.
        address:
          type: string
          nullable: true
          example: Keizersgracht 1
        postal_code:
          type: string
          nullable: true
          example: 1015AA
        city:
          type: string
          nullable: true
          example: Amsterdam
        country:
          type: string
          nullable: true
          example: NL
        vat_number:
          type: string
          nullable: true
          example: NL123456789B01
        locale:
          enum:
            - nl
            - en
            - fr
            - de
            - es
          type: string
          nullable: true
          example: nl
        mollie_customer_id:
          type: string
          nullable: true
          example: cst_abc123
        created_at:
          type: string
          example: '2025-01-15 10:30:00'
    Subscription:
      type: object
      required:
        - id
        - name
        - status
        - start_date
        - created_at
      properties:
        id:
          type: string
          example: sub_abc123
        name:
          type: string
          example: Monthly Premium
        status:
          enum:
            - draft
            - active
            - paused
            - cancelled
            - completed
          type: string
          example: active
        start_date:
          type: string
          example: '2025-01-01'
        mollie_mandate_id:
          type: string
          example: mdt_abc123
        mollie_profile_id:
          type: string
          example: pfl_abc123
        next_payment_at:
          type: string
          nullable: true
          example: '2025-02-01'
        next_amount:
          type: string
          nullable: true
          example: '29.99'
        last_payment_created_at:
          type: string
          nullable: true
          example: '2025-01-01 10:00:00'
        resume_at:
          type: string
          nullable: true
          example: '2025-03-01'
        cancel_at:
          type: string
          nullable: true
          example: '2025-12-31'
        created_at:
          type: string
          example: '2025-01-01 10:00:00'
        rules:
          type: array
          items:
            $ref: '#/components/schemas/SubscriptionRule'
        customer:
          type: object
          additionalProperties:
            type: string
    SubscriptionRule:
      type: object
      required:
        - id
        - amount
        - currency
        - interval
        - interval_amount
        - day
        - times_done
      properties:
        id:
          type: string
          example: rule_abc123
        amount:
          type: string
          example: '29.99'
        currency:
          enum:
            - EUR
          type: string
          example: EUR
        interval:
          enum:
            - day
            - week
            - month
            - year
          type: string
          example: month
        interval_amount:
          type: integer
          example: 1
        day:
          type: integer
          example: 1
        times:
          type: integer
          nullable: true
          example: 12
        times_done:
          type: integer
          example: 3

````