> ## Documentation Index
> Fetch the complete documentation index at: https://razorpay-60c89f9a-mintlify-audit-missing-sections-1778528421.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# List all payment links

> Returns a paginated list of all payment links created for your account.



## OpenAPI

````yaml /openapi/products.json get /payment_links
openapi: 3.1.0
info:
  title: Razorpay Products API
  description: >-
    API specification for Razorpay Payment Links, Subscriptions, and QR Codes
    products.
  version: 1.0.0
  contact:
    name: Razorpay Support
    url: https://razorpay.com/support
servers:
  - url: https://api.razorpay.com/v1
    description: Razorpay Production API
security:
  - basicAuth: []
tags:
  - name: Payment Links
    description: >-
      Create and manage payment links to collect payments from customers without
      building a checkout flow.
  - name: Plans
    description: >-
      Create and manage plans that define the billing period and amount for
      subscriptions.
  - name: Subscriptions
    description: >-
      Create and manage recurring subscriptions for customers based on defined
      plans.
  - name: QR Codes
    description: Create and manage QR codes for accepting UPI payments in-store or online.
  - name: Invoices
    description: Create and manage invoices to bill customers for products and services.
paths:
  /payment_links:
    get:
      tags:
        - Payment Links
      summary: List all payment links
      description: Returns a paginated list of all payment links created for your account.
      operationId: listPaymentLinks
      parameters:
        - name: count
          in: query
          required: false
          description: Number of payment links to return. Default is 10, maximum is 100.
          schema:
            type: integer
            default: 10
            maximum: 100
            example: 10
        - name: skip
          in: query
          required: false
          description: >-
            Number of payment links to skip before returning results. Used for
            pagination.
          schema:
            type: integer
            default: 0
            example: 0
        - name: reference_id
          in: query
          required: false
          description: Filter by your internal reference ID.
          schema:
            type: string
      responses:
        '200':
          description: List of payment links retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListPaymentLinksResponse'
        '401':
          description: Unauthorized. Invalid or missing API credentials.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    ListPaymentLinksResponse:
      type: object
      description: Paginated list of payment links.
      properties:
        entity:
          type: string
          description: Entity type. Always `collection`.
          example: collection
        count:
          type: integer
          description: Number of payment links returned in this response.
          example: 1
        items:
          type: array
          description: List of payment link objects.
          items:
            $ref: '#/components/schemas/PaymentLink'
    ErrorResponse:
      type: object
      description: Standard error response from the Razorpay API.
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              description: Error code.
              example: BAD_REQUEST_ERROR
            description:
              type: string
              description: Human-readable description of the error.
              example: The amount must be greater than 0.
            field:
              type: string
              description: The field that caused the error, if applicable.
              example: amount
              nullable: true
    PaymentLink:
      type: object
      description: A Razorpay Payment Link object.
      properties:
        id:
          type: string
          description: Unique identifier of the payment link.
          example: plink_ERgihyaAAC0VNW
        entity:
          type: string
          description: Entity type. Always `payment_link`.
          example: payment_link
        accept_partial:
          type: boolean
          description: Indicates whether the customer can make a partial payment.
          example: false
        amount:
          type: integer
          description: >-
            Payment link amount in the smallest currency unit (e.g., paise for
            INR).
          example: 50000
        amount_paid:
          type: integer
          description: Amount paid against the payment link so far.
          example: 0
        cancelled_at:
          type: integer
          description: >-
            Unix timestamp at which the payment link was cancelled. `null` if
            not cancelled.
          example: null
          nullable: true
        created_at:
          type: integer
          description: Unix timestamp at which the payment link was created.
          example: 1591097057
        currency:
          type: string
          description: ISO 4217 currency code.
          example: INR
        customer:
          $ref: '#/components/schemas/CustomerObject'
        description:
          type: string
          description: A brief description shown to the customer on the payment page.
          example: 'Payment for policy no #23456'
        expire_by:
          type: integer
          description: Unix timestamp after which the payment link will expire.
          example: 1691097057
          nullable: true
        expired_at:
          type: integer
          description: Unix timestamp at which the payment link expired.
          example: null
          nullable: true
        reference_id:
          type: string
          description: An optional reference identifier you can set for internal use.
          example: TS1989
          nullable: true
        reminder_enable:
          type: boolean
          description: Indicates whether payment reminders are enabled for the link.
          example: true
        short_url:
          type: string
          description: Short URL of the payment link that is shared with customers.
          example: https://rzp.io/i/nxrHnLJ
        status:
          type: string
          description: Current status of the payment link.
          enum:
            - created
            - partially_paid
            - paid
            - cancelled
            - expired
          example: created
        updated_at:
          type: integer
          description: Unix timestamp at which the payment link was last updated.
          example: 1591097057
        user_id:
          type: string
          description: Unique identifier of the Razorpay user who created the payment link.
          example: ''
    CustomerObject:
      type: object
      description: Customer contact details.
      properties:
        name:
          type: string
          description: Name of the customer.
          example: Gaurav Kumar
        email:
          type: string
          format: email
          description: Email address of the customer.
          example: gaurav.kumar@example.com
        contact:
          type: string
          description: Phone number of the customer, including country code.
          example: '+919900000000'
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: Use your Razorpay Key ID as the username and Key Secret as the password.

````