---
title: "Retrieve payment link (publishable)"
method: GET
path: "/publishable/payment_links/links/{publishable_key}/"
tags: ["Payments"]
---

# Retrieve payment link (publishable)

`GET /publishable/payment_links/links/{publishable_key}/`

## Request

- Base URL: `https://api.piriod.com`
- URL: `https://api.piriod.com/publishable/payment_links/links/{publishable_key}/`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/piriod/apis/piriod-api/docs/publishable/payment_links/links/:publishable_key/get.ts> (a function with typed inputs; its response is checked against the schema)

Public read of a payment link by its `publishable_key`. No authentication required.

## Response `200`

The payment link.

- PaymentLinkPublic: Sharable payment link rendered by Piriod (`/publishable/payment_links/links/{publishable_key}/hosted/`).
  - `id` integer
  - `name` string, required
  - `publishable_key` string: Use this key on the publishable endpoints to fetch and pay the link.
  - `cta` 'book' | 'donate' | 'pay'
  - `amount` number, nullable
  - `amount_min` number, nullable
  - `amount_max` number, nullable
  - `amount_preset` number, nullable
  - `amount_scheme` 'custom' | 'fixed'
  - `currency` string, required: ISO currency code.
  - `customer_type` 'individual' | 'business' | 'both'
  - `description` string, nullable
  - `end_description` string, nullable: Markdown shown after a successful payment.
  - `hosted_page_title` string, nullable
  - `hosted_page_description` string, nullable
  - `hosted_page_layout` 'vertical' | 'horizontal'
  - `image` string, uri, nullable
  - `return_url` string, uri, nullable
  - `create_invoice` boolean: When true, completed payments generate an invoice with `document`.
  - `document` integer, nullable
  - `status` 'active' | 'archived'
  - `test_mode` boolean
  - `created` string, date-time
  - `updated` string, date-time

## Other responses

- `404`: Resource not found.

---

[API](https://skmtc.dev/piriod/apis/piriod-api.md) - [All operations](https://skmtc.dev/piriod/apis/piriod-api/llms.txt) - [OpenAPI document](https://skmtc.dev/piriod/apis/piriod-api/revisions/70cbc827dc7b?raw)