> ## Documentation Index > Fetch the complete documentation index at: https://docs.meum.io/llms.txt > Use this file to discover all available pages before exploring further. # List payment links ## OpenAPI ````yaml /openapi.yaml get /v1/payment-links openapi: 3.1.0 info: title: Meum Public Merchant API version: 1.0.0 description: > Public merchant API for programmatic payment management: invoices, transactions, payment links, webhooks, and WooCommerce integration. Authenticate with a store-scoped API key (`sk_live_*`) via Bearer token. Base URL: https://api.meum.io contact: name: Meum Support email: support@meum.io url: https://meum.io servers: - url: https://api.meum.io description: Production security: - bearerAuth: [] tags: - name: Health description: Service health checks - name: Invoices description: Invoice lifecycle - name: Transactions description: On-chain payment transactions - name: Payment Links description: Reusable payment link management - name: Webhooks description: Webhook endpoint and delivery management - name: Integrations description: Third-party platform integrations paths: /v1/payment-links: get: tags: - Payment Links summary: List payment links operationId: listPaymentLinks parameters: - $ref: '#/components/parameters/CursorLimit' - $ref: '#/components/parameters/CursorStartingAfter' responses: '200': description: Paginated payment link list content: application/json: schema: allOf: - $ref: '#/components/schemas/CursorPage' - type: object properties: data: type: array items: $ref: '#/components/schemas/PaymentLink' components: parameters: CursorLimit: name: limit in: query description: How many items to return per page (1–100). Defaults to `20` if omitted. schema: type: integer minimum: 1 maximum: 100 default: 20 CursorStartingAfter: name: starting_after in: query description: > Pagination cursor. Pass the ID of the last item from the previous page to get the next page. Omit on the first request. schema: type: string pattern: ^(inv_|txn_|plink_|wh_|whd_|evt_|int_)[0-9a-z]{20,32}$ schemas: CursorPage: type: object required: - data - has_more - next_cursor properties: data: type: array description: Page of resources for the current request. items: {} has_more: type: boolean description: Whether additional pages exist after this one. example: true next_cursor: type: - string - 'null' format: uuid description: >- Pass as `starting_after` on the next request to fetch the following page. Null when `has_more` is false. example: 550e8400-e29b-41d4-a716-446655440000 PaymentLink: type: object description: Merchant-facing Pay Link resource with configuration and stats. properties: id: type: string pattern: ^(inv_|txn_|plink_|wh_|whd_|evt_|int_)[0-9a-z]{20,32}$ description: Merchant resource ID (`plink_...`). Use in API paths and webhooks. public_id: type: string pattern: ^plpub_[0-9a-z]{20,32}$ description: Buyer-facing token (`plpub_...`) embedded in public checkout URLs. public_url: type: string format: uri description: Shareable checkout page URL for this link. example: https://pay.meum.io/plpub_c9a9bb730611077574c828af5af5fed1 title: type: string description: Link title shown on checkout and in the merchant dashboard. example: Summer fundraiser description: type: - string - 'null' description: Optional description for payers. image_url: type: - string - 'null' format: uri description: Optional image URL displayed on the checkout page. amount_mode: $ref: '#/components/schemas/PaymentLinkAmountMode' amount: type: - string - 'null' description: Fixed price when `amount_mode` is `fixed_amount`. example: '25.00' currency: type: string description: Currency for all amounts on this link. example: USD min_amount: type: - string - 'null' description: Minimum payer-entered amount for variable-amount links. max_amount: type: - string - 'null' description: Maximum payer-entered amount for variable-amount links. suggested_amounts: type: array items: type: number description: Suggested preset amounts shown as quick-select buttons on checkout. example: - 10 - 25 - 50 allow_multiple_payments: type: boolean description: >- When true, the link can generate multiple paid invoices over its lifetime. public_visible: type: boolean description: >- When true, the link is reachable via its public URL without extra auth. status: $ref: '#/components/schemas/PaymentLinkStatus' effective_status: $ref: '#/components/schemas/PaymentLinkStatus' description: Computed status accounting for expiry and usage limits. expires_at: type: - string - 'null' format: date-time description: >- After this time (UTC) the link no longer accepts payments. `null` if it never expires. created_at: type: string format: date-time description: When the link was created. updated_at: type: string format: date-time description: When the link was last modified. stats: $ref: '#/components/schemas/PaymentLinkStats' PaymentLinkAmountMode: type: string description: > How pricing works on this Pay Link: - `fixed_amount`: you set the price; the customer pays exactly that amount - `customer_defined_amount`: the customer chooses how much to pay (within min/max you set) enum: - fixed_amount - customer_defined_amount PaymentLinkStatus: type: string description: | Whether the Pay Link can accept payments right now: - `active`: open for payments - `inactive`: turned off by you; no new payments - `expired`: past its expiration date - `completed`: single-use link already paid, or usage limit reached enum: - active - inactive - expired - completed PaymentLinkStats: type: object description: Aggregated payment metrics for a Pay Link. properties: total_payments: type: string description: Total checkout attempts or invoices created from this link. example: '12' paid_payments: type: string description: Number of successfully paid invoices from this link. example: '10' total_volume: type: string description: Sum of paid amounts in the link's currency (decimal string). example: '250.00' securitySchemes: bearerAuth: type: http scheme: bearer description: | Store-scoped API key. Prefix with `sk_live_`. Example: `Authorization: Bearer sk_live_EXAMPLE_DO_NOT_USE` ````