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

# List payment links

> Lista paginada dos links de pagamento da empresa.



## OpenAPI

````yaml /api-reference/openapi.json get /api/v1/payment-links
openapi: 3.0.0
info:
  title: PlugToPay API
  description: API to make payments easy in multiple gateways.
  version: 1.0.0
servers:
  - url: http://localhost:7701
    description: Test Server
security: []
paths:
  /api/v1/payment-links:
    get:
      tags:
        - Payment Links
      summary: List payment links
      description: Lista paginada dos links de pagamento da empresa.
      parameters:
        - $ref: '#/components/parameters/XClientId'
        - name: per_page
          in: query
          required: false
          schema:
            type: integer
            default: 20
        - name: page
          in: query
          required: false
          schema:
            type: integer
            default: 1
      responses:
        '200':
          description: Lista paginada
          content:
            application/json:
              schema:
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/PaymentLink'
                  meta:
                    type: object
                type: object
        '401':
          description: Unauthorized — Invalid API Key
      security:
        - ApiKeyAuth: []
components:
  parameters:
    XClientId:
      name: x-client-id
      in: header
      description: Client identifier for the company in the request.
      required: true
      schema:
        type: string
        example: client_abc123
  schemas:
    PaymentLink:
      type: object
      properties:
        token:
          type: string
          example: pl_live_a1b2c3d4e5f6
        slug:
          type: string
          nullable: true
          example: curso-premium
        title:
          type: string
          example: Curso Premium
        description:
          type: string
          nullable: true
        type:
          type: string
          enum:
            - one_time
            - subscription
        amount:
          type: integer
          nullable: true
          description: Centavos. Nulo em links de assinatura.
          example: 29900
        currency:
          type: string
          example: BRL
        payment_method:
          type: string
          enum:
            - card
            - pix
          nullable: true
          description: Nulo aceita cartão e PIX.
        plan_id:
          type: integer
          nullable: true
        plan_uuid:
          type: string
          format: uuid
          nullable: true
        items:
          type: array
          nullable: true
          items:
            $ref: '#/components/schemas/PaymentLinkItem'
        success_url:
          type: string
          format: uri
          nullable: true
        cancel_url:
          type: string
          format: uri
          nullable: true
        is_active:
          type: boolean
          example: true
        expires_at:
          type: string
          format: date-time
          nullable: true
        checkout_url:
          type: string
          format: uri
          example: https://checkout.plugtopay.com/minha-empresa/curso-premium
        created_at:
          type: string
          format: date-time
    PaymentLinkItem:
      type: object
      properties:
        name:
          type: string
          example: Curso Premium
        description:
          type: string
          nullable: true
          example: Acesso vitalício
        quantity:
          type: integer
          minimum: 1
          example: 1
        unit_price:
          type: integer
          description: Preço unitário em centavos
          example: 29900
        image_url:
          type: string
          format: uri
          nullable: true
      required:
        - name
        - quantity
        - unit_price
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      description: Company API key. Send in the X-API-Key header.
      name: X-API-Key
      in: header

````