> ## Documentation Index > Fetch the complete documentation index at: https://docs.compago.com/llms.txt > Use this file to discover all available pages before exploring further. # List payment links > Your payment links with their current fields and products. Archived links are hidden unless `archived=true`. ## OpenAPI ````yaml GET /developer/v1/payment-link openapi: 3.1.0 info: title: Compago API version: 1.0.0 description: >- Public and private API endpoints for Compago's payment infrastructure. This specification currently includes endpoints for one-time payments. More endpoints will be added as the platform evolves. servers: - url: https://demo-api-harmony.compago.com/api - url: https://api-harmony.compago.com/api security: [] tags: - name: OneTimePayment description: Endpoints for creating and processing one-time payment links - name: PaymentMethod description: >- Endpoints for saving cards, charging saved payment methods, holding and capturing funds, and processing refunds - name: PaymentIntent description: >- Endpoints for creating and managing card-present payment intents for POS terminal integrations - name: Payments description: Read the payments your organization has taken - name: Subscriptions description: Read and manage recurring billing agreements - name: PaymentLinks description: Create, edit and retire hosted checkout links - name: Products description: Manage the catalogue behind product-based payment links - name: Promotions description: Read the promotions your organization funds or benefits from - name: Salespeople description: Read the point-of-sale operators in your organization - name: Organization description: Read your organization profile and its members - name: SavedCards description: Read saved payment methods and their payments paths: /developer/v1/payment-link: get: tags: - PaymentLinks summary: List payment links description: >- Your payment links with their current fields and products. Archived links are hidden unless `archived=true`. operationId: listPublicPaymentLinks parameters: - name: limit in: query schema: type: integer minimum: 1 maximum: 100 default: 20 description: Rows per page. Values above 100 are rejected. - name: cursor in: query schema: type: string description: >- Opaque cursor from a previous response's `pagination.nextCursor`. Omit for the first page. - name: status in: query schema: type: string enum: - ACTIVE - INACTIVE description: Filter by status. - name: type in: query schema: type: string enum: - PRODUCT_BASED - FIXED_AMOUNT - SUBSCRIPTION - FLEXIBLE_AMOUNT description: Filter by type. - name: archived in: query schema: type: string enum: - 'true' - 'false' description: Set to `true` to list archived links instead of live ones. responses: '200': description: Success. content: application/json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/PublicPaymentLink' pagination: $ref: '#/components/schemas/PublicPagination' required: - data - pagination '400': description: Invalid request. A query parameter failed validation. content: application/json: schema: $ref: '#/components/schemas/PublicError' '401': description: Unauthorized. The `x-api-key` header is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/PublicError' '403': description: >- Forbidden. The key is not bound to an organization, or the organization is not a merchant. content: application/json: schema: $ref: '#/components/schemas/PublicError' '429': description: >- Rate limit exceeded. See the `Retry-After` and `X-RateLimit-*` headers. content: application/json: schema: $ref: '#/components/schemas/PublicError' security: - ApiKeyAuth: [] components: schemas: PublicPaymentLink: type: object properties: id: type: string format: uuid url: type: string format: uri description: The checkout URL to send the customer to. type: type: string enum: - PRODUCT_BASED - FIXED_AMOUNT - SUBSCRIPTION - FLEXIBLE_AMOUNT status: type: string enum: - ACTIVE - INACTIVE archived: type: boolean version: type: integer description: Revision counter, bumped by every edit. title: type: - string - 'null' description: type: - string - 'null' amount: type: - number - 'null' description: >- Null on product-based links, where the total comes from the products. currency: type: - string - 'null' currentUsage: type: - integer - 'null' maxUsage: type: - integer - 'null' calculateTaxes: type: boolean requestShippingAddress: type: boolean requestPhoneNumber: type: boolean allowPromotionCodes: type: boolean callToActionMessage: type: - string - 'null' onSuccessAction: type: - string - 'null' redirectUrl: type: - string - 'null' customConfirmationMessage: type: - string - 'null' allowedTerms: type: - array - 'null' items: type: integer example: - 12 description: >- The installment plans the checkout offers, as numbers of monthly installments (`1` is a single payment). `null` offers every plan active on your account. Always `null` on `SUBSCRIPTION` links, which are charged in a single payment every cycle. billingPeriod: type: - string - 'null' description: Subscription links only. subscriptionDurationType: type: - string - 'null' description: Subscription links only. fixedBillingCycles: type: - integer - 'null' description: Subscription links only. trialPeriodValue: type: - integer - 'null' description: Subscription links only. trialPeriodUnit: type: - string - 'null' description: Subscription links only. createdAt: type: string format: date-time updatedAt: type: string format: date-time fields: type: array items: $ref: '#/components/schemas/PublicPaymentLinkField' products: type: array items: $ref: '#/components/schemas/PublicPaymentLinkProduct' required: - id - url - type - status PublicPagination: type: object properties: limit: type: integer description: Rows requested for this page. hasMore: type: boolean description: Whether another page exists. nextCursor: type: - string - 'null' description: Pass as `?cursor=` to fetch the next page. Null on the last page. required: - limit - hasMore - nextCursor PublicError: type: object properties: message: type: string description: Human-readable description. code: type: string description: Stable machine-readable code. Branch on this, not on `message`. required: - message PublicPaymentLinkField: type: object properties: id: type: string format: uuid title: type: string type: type: string enum: - TEXT - NUMBER - DATE isOptional: type: boolean sequence: type: integer PublicPaymentLinkProduct: type: object properties: id: type: string format: uuid quantity: type: - integer - 'null' product: oneOf: - $ref: '#/components/schemas/PublicProduct' - type: 'null' PublicProduct: type: object properties: id: type: string format: uuid name: type: string description: type: - string - 'null' status: type: string enum: - ACTIVE - ARCHIVED price: type: number currency: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time required: - id - name - status - price - currency securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-api-key ````