---
title: "List payment links"
method: GET
path: "/payment_links"
tags: ["Payment Links"]
---

# List payment links

`GET /payment_links`

Get the list of all payment links

## Query parameters

- `per_page` integer
- `page` integer
- `publish_status` 'published' | 'draft'

## Response `200`

Successful response

- object
  - `data` PaymentLink[]
    - `trip` object — Trip information associated with the payment link
      - `uuid` string — UUID of the trip
      - `title` string — Title of the trip
      - `trip_id` string — Trip reference ID
      - `url` string — URL of the trip
      - `defaultImageUrl` string — Default image URL for the trip
      - `start_date` string — Start date of the trip in ISO 8601 format
      - `end_date` string — End date of the trip in ISO 8601 format
      - `currency` string — Currency code (e.g., USD, EUR, GBP)
      - `participant_fees` 'credit_card' | 'service' | 'all' | 'none' — Allows you to choose how the payment fees are handled. The available options are: “credit_card” - Bank account payments are free for the participant, but if they choose to pay by credit card, a card fee is added to the price “service” - Service fees are paid by the participant. Payment method fees are covered by the organizer. “all” - all fees are paid by the participant “none” - all fees are paid by the organizer
    - `pricing` object — Pricing information for the payment link
      - `price` number, double — Price of the trip
      - `days_before_departure` integer — Whether this trip has a booking deadline. The deadline is defined in relation to the trip start date. E.g. if this setting is set to “5” and the trip starts on January 15, then the booking deadline will be January 10.
      - `payment_plan` object — Payment plan
        - `allow_auto_payment` boolean — Participants will automatically be auto-billed to their default payment method when each payment is due.
        - `allow_partial_payment` boolean — Allow participants to make partial payments
        - `deposit` number, double — Deposit price of the package
        - `installments` Installment[] — Payment installments (max 18)
          - `type` 'deposit' | 'due_at_booking' | 'installment' — Type: “deposit”, "due_at_booking" or “installment”
          - `total` integer — Amount of the specific installment
          - `previous_payment` integer — Amount of the previous payment (applies for partial installment payments)
          - `due` integer — Amount that is due for the specific installment
          - `paid` boolean — Whether the installment has been fully paid or not
          - `date` string, date, nullable — The installment due date in ISO 8601 format, e.g. “2021-06-25”
  - `pagination` Pagination — Pagination object
    - `total_count` integer — Total number of leads
    - `page` integer — Current page number where the lead is found
    - `per_page` integer — How many lead are per page (default: 25)
    - `total_pages` integer — Total number of pages
    - `has_previous` boolean — Whether the previous page is there or not
    - `has_next` boolean — Whether the next page is there or not

## Other responses

- `401` — Unauthorized

---

[API](https://skmtc.dev/wetravel/apis/authentication-api.md) · [All operations](https://skmtc.dev/wetravel/apis/authentication-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/wetravel/authentication-api/revisions/5c747875f084/schema)